[arvados] updated: 2.6.0-20-g499240fcf
git repository hosting
git at public.arvados.org
Tue Apr 18 15:19:22 UTC 2023
Summary of changes:
sdk/python/discovery2pydoc.py | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
via 499240fcfa25c10bc22277b7d382dcbc31436cbe (commit)
via 22dfbd2ea818464019f605b4103124d58c7355bd (commit)
from bce5560c00bc5cb6301da0ddd82f3af8a4b24778 (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 499240fcfa25c10bc22277b7d382dcbc31436cbe
Author: Brett Smith <brett.smith at curii.com>
Date: Tue Apr 18 11:13:08 2023 -0400
18799: Make schema docstring more specific about how to select object keys
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 4b65ff2b7..dad27f09a 100755
--- a/sdk/python/discovery2pydoc.py
+++ b/sdk/python/discovery2pydoc.py
@@ -90,8 +90,8 @@ This is the dictionary object that represents a single {cls_name} in Arvados
and is returned by most `{cls_name}s` methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
-Refer to the API documentation for details about how to retrieve specific keys
-if you need them.
+When a method doesn't return all the data, you can use its `select` parameter
+to list the specific keys you need. Refer to the API documentation for details.
'''
_MODULE_PRELUDE = '''
commit 22dfbd2ea818464019f605b4103124d58c7355bd
Author: Brett Smith <brett.smith at curii.com>
Date: Tue Apr 18 11:07:54 2023 -0400
18799: Link back to resource class from schema docstring
This makes the connection bidirectional, which helps both understanding
and navigation.
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 29502ace1..4b65ff2b7 100755
--- a/sdk/python/discovery2pydoc.py
+++ b/sdk/python/discovery2pydoc.py
@@ -86,7 +86,8 @@ generated dynamically at runtime when the client object is built.
'''
_SCHEMA_PYDOC = '''
-This is the dictionary object that represents a single {cls_name} in Arvados.
+This is the dictionary object that represents a single {cls_name} in Arvados
+and is returned by most `{cls_name}s` methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
Refer to the API documentation for details about how to retrieve specific keys
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list