[arvados] updated: 2.7.0-5415-g75aee7b3d5
git repository hosting
git at public.arvados.org
Tue Nov 21 22:30:15 UTC 2023
Summary of changes:
sdk/python/discovery2pydoc.py | 89 ++++++++++++++++++++++++++++++++++---------
1 file changed, 72 insertions(+), 17 deletions(-)
via 75aee7b3d5b6c8e84e25e71eefe88040d8a12022 (commit)
via f2fed419ccf62d5c3998fe85fa19a051db8b1f24 (commit)
via 44f7408d23ccfbb51dbc06522302af5e4aa53da7 (commit)
via 4571ee1ebc16366997b28561e85e07717da62be9 (commit)
via 6f481c9e2379cc470d2fb392b6fd495fc7cc8f21 (commit)
from 9c3df07fcefc04fcc8078a426c69215f49e63bf3 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 75aee7b3d5b6c8e84e25e71eefe88040d8a12022
Merge: 9c3df07fce f2fed419cc
Author: Brett Smith <brett.smith at curii.com>
Date: Tue Nov 21 17:29:13 2023 -0500
Merge branch '21132-api-resources-fixes'
Closes #21132, #21136.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
commit f2fed419ccf62d5c3998fe85fa19a051db8b1f24
Author: Brett Smith <brett.smith at curii.com>
Date: Tue Nov 21 17:16:18 2023 -0500
21132: Expand arvados.api_resources docstring with more detail about its purpose
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/sdk/python/discovery2pydoc.py b/sdk/python/discovery2pydoc.py
index 4fe050baf0..70a51371ac 100755
--- a/sdk/python/discovery2pydoc.py
+++ b/sdk/python/discovery2pydoc.py
@@ -77,12 +77,19 @@ If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The `items` key maps to a list of matching
`{cls_name}` objects.
'''
-_MODULE_PYDOC = '''Arvados API client documentation skeleton
-
-This module documents the methods and return types provided by the Arvados API
-client. Start with `ArvadosAPIClient`, which documents the methods available
-from the API client objects constructed by `arvados.api`. The implementation is
-generated dynamically at runtime when the client object is built.
+_MODULE_PYDOC = '''Arvados API client reference documentation
+
+This module provides reference documentation for the interface of the
+Arvados API client, including method signatures and type information for
+returned objects. However, the functions in `arvados.api` will return
+different classes at runtime that are generated dynamically from the Arvados
+API discovery document. The classes in this module do not have any
+implementation, and you should not instantiate them in your code.
+
+If you're just starting out, `ArvadosAPIClient` documents the methods
+available from the client object. From there, you can follow the trail into
+resource methods, request objects, and finally the data dictionaries returned
+by the API server.
'''
_SCHEMA_PYDOC = '''
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list