Skip to content

Commit

Permalink
Merge branch '255-update-api-docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
amercader committed Mar 12, 2013
2 parents ea27c01 + 4661821 commit 290f9e0
Show file tree
Hide file tree
Showing 23 changed files with 586 additions and 1,044 deletions.
5 changes: 0 additions & 5 deletions ckan/logic/action/create.py
Expand Up @@ -671,11 +671,6 @@ def organization_create(context, data_dict):
the dataset) and optionally ``'title'`` (string, the title of the
dataset)
:type packages: list of dictionaries
## :param groups: the groups that belong to the group, a list of dictionaries
## each with key ``'name'`` (string, the id or name of the group) and
## optionally ``'capacity'`` (string, the capacity in which the group is
## a member of the group)
## :type groups: list of dictionaries
:param users: the users that belong to the organization, a list of dictionaries
each with key ``'name'`` (string, the id or name of the user) and
optionally ``'capacity'`` (string, the capacity in which the user is
Expand Down
12 changes: 6 additions & 6 deletions ckan/logic/action/get.py
Expand Up @@ -2583,19 +2583,19 @@ def group_followee_list(context, data_dict):
def dashboard_activity_list(context, data_dict):
'''Return the authorized user's dashboard activity stream.
Unlike the activity dictionaries returned by other *_activity_list actions,
these activity dictionaries have an extra boolean value with key 'is_new'
that tells you whether the activity happened since the user last viewed her
dashboard ('is_new': True) or not ('is_new': False).
Unlike the activity dictionaries returned by other ``*_activity_list``
actions, these activity dictionaries have an extra boolean value with key
``is_new`` that tells you whether the activity happened since the user last
viewed her dashboard (``'is_new': True``) or not (``'is_new': False``).
The user's own activities are always marked 'is_new': False.
The user's own activities are always marked ``'is_new': False``.
:param offset: where to start getting activity items from
(optional, default: 0)
:type offset: int
:param limit: the maximum number of activities to return
(optional, default: 31, the default value is configurable via the
ckan.activity_list_limit setting)
``ckan.activity_list_limit`` setting)
:rtype: list of activity dictionaries
Expand Down
2 changes: 1 addition & 1 deletion ckan/plugins/interfaces.py
Expand Up @@ -205,7 +205,7 @@ def can_preview(self, data_dict):
Return True if the extension can preview the resource. The ``data_dict``
contains the resource and the package.
Make sure you also make sure to ckeck the ``on_same_domain`` value of the
Make sure to ckeck the ``on_same_domain`` value of the
resource or the url if your preview requires the resource to be on
the same domain because of the same origin policy.
'''
Expand Down
118 changes: 0 additions & 118 deletions doc/api-tutorial.rst

This file was deleted.

128 changes: 0 additions & 128 deletions doc/api-util.rst

This file was deleted.

0 comments on commit 290f9e0

Please sign in to comment.