From ea1a94e9e4b62e38e9eb5e5e7171afe75346b41e Mon Sep 17 00:00:00 2001 From: rolux Date: Sun, 21 Dec 2014 13:03:49 +0000 Subject: [PATCH] update api docs (omissions, wording, typos) --- pandora/archive/views.py | 2 +- pandora/document/views.py | 2 +- pandora/edit/views.py | 3 ++- pandora/itemlist/views.py | 2 +- pandora/text/views.py | 2 +- pandora/tv/views.py | 2 +- pandora/user/views.py | 2 +- 7 files changed, 8 insertions(+), 7 deletions(-) diff --git a/pandora/archive/views.py b/pandora/archive/views.py index c37fb45a0..7fb8a22d0 100644 --- a/pandora/archive/views.py +++ b/pandora/archive/views.py @@ -341,7 +341,7 @@ def direct_upload(request): @login_required_json def taskStatus(request, data): ''' - Gets the status for a task + Gets the status for a given task takes { taskId: string // taskId } diff --git a/pandora/document/views.py b/pandora/document/views.py index 0a912011b..b21433b75 100644 --- a/pandora/document/views.py +++ b/pandora/document/views.py @@ -247,7 +247,7 @@ actions.register(removeDocument, cache=False) @login_required_json def sortDocuments(request, data): ''' - Sets the sort order for the documents related to a given item + Sets the sort order for the documents associated with a given item takes { item: string, // item id ids: [string] // ordered list of document ids diff --git a/pandora/edit/views.py b/pandora/edit/views.py index 1e2464a98..e9a9556da 100644 --- a/pandora/edit/views.py +++ b/pandora/edit/views.py @@ -200,7 +200,7 @@ def _order_clips(edit, sort): def sortClips(request, data): ''' - Updates sort order of clips within an edit + Updates the sort order of clips within an edit takes { edit: string, // edit id sort: object // sort @@ -480,6 +480,7 @@ actions.register(unsubscribeFromEdit, cache=False) @login_required_json def sortEdits(request, data): ''' + Sets the order of edits in a given section takes { section: string, // 'personal', 'favorite' or 'featured' ids: [string] // ordered list of edit ids diff --git a/pandora/itemlist/views.py b/pandora/itemlist/views.py index 011c145f9..243208d54 100644 --- a/pandora/itemlist/views.py +++ b/pandora/itemlist/views.py @@ -192,7 +192,7 @@ actions.register(removeListItems, cache=False) @login_required_json def orderListItems(request, data): ''' - Sets the manual orderings of items in a given list + Sets the manual ordering of items in a given list takes { list: string, // list id ids: [string] // ordered list of item ids diff --git a/pandora/text/views.py b/pandora/text/views.py index aabf00fab..7e3a1dc4f 100644 --- a/pandora/text/views.py +++ b/pandora/text/views.py @@ -311,7 +311,7 @@ actions.register(unsubscribeFromText, cache=False) @login_required_json def sortTexts(request, data): ''' - Sets manual ordering of texts in a given folder + Sets the order of texts in a given section takes { section: string, // 'personal', 'favorite' or 'featured' ids: [string] // ordered list of text ids diff --git a/pandora/tv/views.py b/pandora/tv/views.py index 06d79820f..4636bc2b8 100644 --- a/pandora/tv/views.py +++ b/pandora/tv/views.py @@ -11,7 +11,7 @@ from ox.django.api import actions def tv(request, data): ''' - Gets TV program for a given list + Gets the current TV program for a given list takes { list: string // list name } diff --git a/pandora/user/views.py b/pandora/user/views.py index 30a35508d..5ffc1f42b 100644 --- a/pandora/user/views.py +++ b/pandora/user/views.py @@ -213,7 +213,7 @@ actions.register(signup, cache=False) def resetPassword(request, data): ''' - Resets password for a given user + Resets the password for a given user takes { username: string, // username password: string, // password