Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 6ca7f8b

Browse files
sanfilipsanfilip
committed
doc refresh
1 parent 5857dc1 commit 6ca7f8b

23 files changed

+47
-41
lines changed

‎docs/accounts.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ <h5>Parameters:</h5>
430430
<br class="clear">
431431

432432
<footer>
433-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
433+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
434434
</footer>
435435

436436
<script>prettyPrint();</script>

‎docs/accounts_index.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ <h1 class="page-title">accounts/index.js</h1>
5858
<br class="clear">
5959

6060
<footer>
61-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
61+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6262
</footer>
6363

6464
<script>prettyPrint();</script>

‎docs/accounts_script.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h1 class="page-title">accounts/script.js</h1>
107107
<br class="clear">
108108

109109
<footer>
110-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
110+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
111111
</footer>
112112

113113
<script>prettyPrint();</script>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
105105
<br class="clear">
106106

107107
<footer>
108-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
108+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
109109
</footer>
110110

111111
<script>prettyPrint();</script>

‎docs/machines.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ <h6>Properties</h6>
354354

355355

356356

357-
<td class="description last"><p>Name of the region ('East Coast (NY2)' or 'West Coast (CA1)')</p></td>
357+
<td class="description last"><p>Name of the region: 'East Coast (NY2)' or 'West Coast (CA1)'</p></td>
358358
</tr>
359359

360360

@@ -385,7 +385,10 @@ <h6>Properties</h6>
385385

386386

387387

388-
<td class="description last"><p>Machine preset type (Air/Basic/Pro)</p></td>
388+
<td class="description last"><p>Machine type: either 'Air', 'Standard', 'Pro', 'Advanced', 'GPU+', 'P5000', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', or 'C10'<p>
389+
Note:<br>
390+
Windows os templates cannot be used to create CPU-only machine types 'C1' - 'C10'.<br>
391+
Ubuntu os templates cannot be used to create GRID GPU machine types: 'Air', 'Standard', 'Pro', or 'Advanced'.</p></td>
389392
</tr>
390393

391394

@@ -2490,7 +2493,7 @@ <h5>Returns:</h5>
24902493
<br class="clear">
24912494

24922495
<footer>
2493-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2496+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
24942497
</footer>
24952498

24962499
<script>prettyPrint();</script>

‎docs/machines_create.js.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,11 @@ <h1 class="page-title">machines/create.js</h1>
5252
* them the machine. This action can only be performed by the account owner. (Team members cannot
5353
* create machines themselves; only the team administrator may do so.)
5454
* @param {object} params - Machine creation parameters
55-
* @param {string} params.region - Name of the region ('East Coast (NY2)' or 'West Coast (CA1)')
56-
* @param {string} params.machineType - Machine preset type (Air/Basic/Pro)
55+
* @param {string} params.region - Name of the region: 'East Coast (NY2)' or 'West Coast (CA1)'
56+
* @param {string} params.machineType - Machine type: either 'Air', 'Standard', 'Pro', 'Advanced', 'GPU+', 'P5000', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', or 'C10'&lt;p>
57+
* Note:&lt;br>
58+
* Windows os templates cannot be used to create CPU-only machine types 'C1' - 'C10'.&lt;br>
59+
* Ubuntu os templates cannot be used to create GRID GPU machine types: 'Air', 'Standard', 'Pro', or 'Advanced'.
5760
* @param {number} params.size - Storage size for the machine in GB
5861
* @param {string} params.billingType - Either 'monthly' or 'hourly' billing
5962
* @param {string} params.machineName - A memorable name for this machine
@@ -172,7 +175,7 @@ <h1 class="page-title">machines/create.js</h1>
172175
<br class="clear">
173176

174177
<footer>
175-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
178+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
176179
</footer>
177180

178181
<script>prettyPrint();</script>

‎docs/machines_destroy.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h1 class="page-title">machines/destroy.js</h1>
9898
<br class="clear">
9999

100100
<footer>
101-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
101+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
102102
</footer>
103103

104104
<script>prettyPrint();</script>

‎docs/machines_index.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ <h1 class="page-title">machines/index.js</h1>
6565
<br class="clear">
6666

6767
<footer>
68-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
68+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6969
</footer>
7070

7171
<script>prettyPrint();</script>

‎docs/machines_list.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h1 class="page-title">machines/list.js</h1>
119119
<br class="clear">
120120

121121
<footer>
122-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
122+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
123123
</footer>
124124

125125
<script>prettyPrint();</script>

‎docs/machines_restart.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h1 class="page-title">machines/restart.js</h1>
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 23 2017 01:24:34 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 14:32:26 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100100
</footer>
101101

102102
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)