18799: Link back to resource class from schema docstring
authorBrett Smith <brett.smith@curii.com>
Tue, 18 Apr 2023 15:07:54 +0000 (11:07 -0400)
committerBrett Smith <brett.smith@curii.com>
Tue, 18 Apr 2023 15:13:56 +0000 (11:13 -0400)
This makes the connection bidirectional, which helps both understanding
and navigation.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

sdk/python/discovery2pydoc.py

index 29502ace1e0eab32446d08b0094bf14dbcfa7d35..4b65ff2b7e33b84a7fa2388334746a52529376a7 100755 (executable)
@@ -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