Bug #22257
closed
Provide more orientation in PySDK module pydocs
Added by Brett Smith 5 days ago.
Updated 3 days ago.
Description
- Explain the relationship between the API client and
arvados.api_resources in the arvados and/or arvados.api docstring. (Right now it's explained from the arvados.api_resources docstring, but that's not helpful if you never open it.)
- Consider writing a little more orientation in the
arvados.api docstring.
- Has duplicate Bug #22259: pydoc should direct reader to api_resources added
- Status changed from New to In Progress
22257-pydoc-api-xref @ a24298ab76c71fd3152d86997da925ddc03caff4 - developer-run-tests: #4529 
- All agreed upon points are implemented / addressed.
- Anything not implemented (discovered or discussed during work) has a follow-up story.
- Code is tested and passing, both automated and manual, what manual testing was done is described
- Documentation has been updated.
- That's all this branch does
- Behaves appropriately at the intended scale (describe intended scale).
- Considered backwards and forwards compatibility issues between client and server.
- No change in compatibility
- Follows our coding standards and GUI style guidelines.
Brett Smith wrote in #note-2:
22257-pydoc-api-xref @ a24298ab76c71fd3152d86997da925ddc03caff4 - developer-run-tests: #4529
- All agreed upon points are implemented / addressed.
- Anything not implemented (discovered or discussed during work) has a follow-up story.
- Code is tested and passing, both automated and manual, what manual testing was done is described
- Documentation has been updated.
- That's all this branch does
- Behaves appropriately at the intended scale (describe intended scale).
- Considered backwards and forwards compatibility issues between client and server.
- No change in compatibility
- Follows our coding standards and GUI style guidelines.
LGTM
- Status changed from In Progress to Resolved
Also available in: Atom
PDF
Updated by 
Updated by