Skip to content

Commit 68361f7

Browse files
committed
Update documentation for create/delete folder
1 parent ed62e96 commit 68361f7

File tree

2 files changed

+31
-26
lines changed

2 files changed

+31
-26
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
guide/gis module/.ipynb_checkpoints/class gis.ContentManager-checkpoint.ipynb

guide/gis module/class gis.ContentManager.ipynb

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"cell_type": "markdown",
2626
"metadata": {},
2727
"source": [
28-
"Manager class for manipulating GIS content. This class is not created by users directly. An instance of this class, called ‘content’, is available as a property of the Gis object. Users call methods on this ‘content’ object to manipulate (create, get, search...) items."
28+
"Manager class for manipulating GIS content. This class is not created by users directly. An instance of this class, called ‘content’, is available as a property of the GIS object. Users call methods on this ‘content’ object to manipulate (create, get, search...) items."
2929
]
3030
},
3131
{
@@ -184,14 +184,14 @@
184184
"cell_type": "markdown",
185185
"metadata": {},
186186
"source": [
187-
"### create_folder(<i>owner, title</i>)"
187+
"### create_folder(<i>owner, folder</i>)"
188188
]
189189
},
190190
{
191191
"cell_type": "markdown",
192192
"metadata": {},
193193
"source": [
194-
"Creates a folder for the given user with the given title."
194+
"Creates a folder for the given user with the given folder name. Does nothing if the folder already exists."
195195
]
196196
},
197197
{
@@ -211,13 +211,13 @@
211211
"<tr class=\"row-even\"><td>owner</td>\n",
212212
"<td>required string, the name of the user</td>\n",
213213
"</tr>\n",
214-
"<tr class=\"row-even\"><td>title</td>\n",
214+
"<tr class=\"row-even\"><td>folder</td>\n",
215215
"<td>required string, the name of the folder to create for the owner</td>\n",
216216
"</tr>\n",
217217
"</tbody>\n",
218218
"</table>\n",
219219
"\n",
220-
"**Returns:**\ta python dict like the following: {“username” : “portaladmin”,”id” : “bff13218991c4485a62c81db3512396f”,”title” : “testcreate”}"
220+
"**Returns:**\ta python dict like the following: {“username” : “portaladmin”,”id” : “bff13218991c4485a62c81db3512396f”,”title” : “testcreate”} if the folder was created, None otherwise."
221221
]
222222
},
223223
{
@@ -255,14 +255,14 @@
255255
"cell_type": "markdown",
256256
"metadata": {},
257257
"source": [
258-
"### get(<i>itemid</i>)"
258+
"### delete_folder(<i>owner, folder</i>)"
259259
]
260260
},
261261
{
262262
"cell_type": "markdown",
263263
"metadata": {},
264264
"source": [
265-
"Returns the item object for the specified itemid."
265+
"Deletes a folder for the given user with the given folder name."
266266
]
267267
},
268268
{
@@ -279,37 +279,43 @@
279279
"<tr class=\"row-odd\"><td><strong>Argument</strong></td>\n",
280280
"<td><strong>Description</strong></td>\n",
281281
"</tr>\n",
282-
"<tr class=\"row-even\"><td>itemid</td>\n",
283-
"<td> required string, the item identifier</td>\n",
282+
"<tr class=\"row-even\"><td>owner</td>\n",
283+
"<td>required string, the name of the user</td>\n",
284+
"</tr>\n",
285+
"<tr class=\"row-even\"><td>folder</td>\n",
286+
"<td>required string, the name of the folder to delete</td>\n",
284287
"</tr>\n",
285288
"</tbody>\n",
286289
"</table>\n",
287290
"\n",
288-
"**Returns:**\tNone if the item is not found and returns an item object if the item is found"
291+
"**Returns:**\tTrue if succeeded, False otherwise"
289292
]
290293
},
291294
{
292295
"cell_type": "markdown",
293-
"metadata": {
294-
"collapsed": false
295-
},
296+
"metadata": {},
296297
"source": [
297-
"<hr>"
298+
"<hr/>"
298299
]
299300
},
300301
{
301302
"cell_type": "markdown",
302303
"metadata": {},
303304
"source": [
304-
"### get_folder_id(<i>owner, folder_name</i>)"
305+
"### get(<i>itemid</i>)"
306+
]
307+
},
308+
{
309+
"cell_type": "markdown",
310+
"metadata": {},
311+
"source": [
312+
"Returns the item object for the specified itemid."
305313
]
306314
},
307315
{
308316
"cell_type": "markdown",
309317
"metadata": {},
310318
"source": [
311-
"Finds the folder for a particular owner and returns its id.\n",
312-
"\n",
313319
"**Arguments:**\n",
314320
"<table border=\"1\" class=\"docutils\">\n",
315321
"<colgroup>\n",
@@ -320,22 +326,20 @@
320326
"<tr class=\"row-odd\"><td><strong>Argument</strong></td>\n",
321327
"<td><strong>Description</strong></td>\n",
322328
"</tr>\n",
323-
"<tr class=\"row-even\"><td>owner</td>\n",
324-
"<td>required string, the name of the user</td>\n",
325-
"</tr>\n",
326-
"<tr class=\"row-even\"><td>folder_name</td>\n",
327-
"<td>required string, the name of the folder to search for</td>\n",
329+
"<tr class=\"row-even\"><td>itemid</td>\n",
330+
"<td> required string, the item identifier</td>\n",
328331
"</tr>\n",
329332
"</tbody>\n",
330333
"</table>\n",
331334
"\n",
332-
"**Returns:**\n",
333-
"the folder id, if the folder is found"
335+
"**Returns:**\tNone if the item is not found and returns an item object if the item is found"
334336
]
335337
},
336338
{
337339
"cell_type": "markdown",
338-
"metadata": {},
340+
"metadata": {
341+
"collapsed": false
342+
},
339343
"source": [
340344
"<hr>"
341345
]
@@ -491,7 +495,7 @@
491495
"name": "python",
492496
"nbconvert_exporter": "python",
493497
"pygments_lexer": "ipython3",
494-
"version": "3.5.1"
498+
"version": "3.4.4"
495499
},
496500
"widgets": {
497501
"state": {},

0 commit comments

Comments
 (0)