21132: Annotate API methods as returning a request object 21132-api-resources-fixes
authorBrett Smith <brett.smith@curii.com>
Sat, 18 Nov 2023 21:41:04 +0000 (16:41 -0500)
committerBrett Smith <brett.smith@curii.com>
Sat, 18 Nov 2023 21:41:04 +0000 (16:41 -0500)
commit44f7408d23ccfbb51dbc06522302af5e4aa53da7
tree4ee0fabd80fa071c093d78399113c4765f698147
parent4571ee1ebc16366997b28561e85e07717da62be9
21132: Annotate API methods as returning a request object

This is a factual correction. Before this, it looked like the API
methods communicated with the API server and returned a response
directly, which is not true.

Unfortunately pdoc doesn't render the documentation for the
ArvadosAPIRequest.execute override. That's frustrating. I looked for
ways to coerce this but didn't find any. Hopefully the class docstring
gives users enough information about what they need to do. pydoc renders
it as expected, so I still think it's worth keeping.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>
sdk/python/discovery2pydoc.py