Merge pull request #84 from girder/improve-python-client-doc

Docs: Improve description of "limit" in listExtension and listApplicationPackage
girder · May 10, 2021 · ed618c5 · ed618c5
2 parents 19a37f5 + 9b39042
commit ed618c5
Showing 1 changed file with 10 additions and 6 deletions.
diff --git a/python_client/slicer_package_manager_client/__init__.py b/python_client/slicer_package_manager_client/__init__.py
@@ -350,9 +350,10 @@ def listExtension(self, app_name, coll_id=None, name=None, ext_os=None, arch=Non
                       app_revision=None, release=Constant.DRAFT_RELEASE_NAME,
                       limit=Constant.DEFAULT_LIMIT, all=False):
         """
-        List the extension of a specific application ``app_name``.
+        List the extensions of a specific application ``app_name``.
 
-        By default the extensions within the ``draft`` release are listed.
+        By default only the first N extensions within the ``draft`` release are listed. Setting ``limit``
+        parameter to `0` removes this restriction.
 
         Specifying optional parameters like `ext_os` or `arch` allows to return the
         corresponding subset.
@@ -367,7 +368,7 @@ def listExtension(self, app_name, coll_id=None, name=None, ext_os=None, arch=Non
         :param arch: The os chip architecture
         :param app_revision: Revision of the application
         :param release: Name of the release
-        :param limit: Limit of the number of extensions listed
+        :param limit: Limit of the number of extensions listed (see :const:`Constant.DEFAULT_LIMIT`)
         :param all: Boolean that allow to list extensions from all the release
         :return: A list of extensions filtered by optional parameters
         """
@@ -516,8 +517,11 @@ def downloadApplicationPackage(self, app_name, id_or_name, coll_id=None,
     def listApplicationPackage(self, app_name, coll_id=None, name=None, pkg_os=None, arch=None,
                                revision=None, release=None, limit=Constant.DEFAULT_LIMIT):
         """
-        List all the application package filtered by some optional parameters (os, arch, ...).
-        By default all the application packages are listed.
+        List the application packages filtered by some optional parameters (os, arch, ...).
+
+        By default only the first N application packages are listed. Setting the ``limit`` parameter
+        to `0` removes this restriction.
+
         It's also possible to specify the ``--release`` option to list all the package from a
         specific release.
 
@@ -528,7 +532,7 @@ def listApplicationPackage(self, app_name, coll_id=None, name=None, pkg_os=None,
         :param arch: The os chip architecture
         :param revision: Revision of the application
         :param release: Name of the release
-        :param limit: Limit of the number of extensions listed
+        :param limit: Limit of the number of applications listed (see :const:`Constant.DEFAULT_LIMIT`)
         :return: A list of application package filtered by optional parameters
         """
         app = self._getApp(app_name=app_name, coll_id=coll_id)