Idea #19818
closed
Write docstrings for arvados.api
Added by Brett Smith almost 2 years ago.
Updated about 1 year ago.
Release relationship:
Auto
Description
Ensure all public classes, methods, and functions in the arvados.api
module have docstrings in our style.
- Related to Idea #18800: Update Python SDK documentation added
The main constructors and supporting functions got documented during #19686. There are some small supporting functions and classes we might want to refresh, but this is definitely a smaller story with less priority.
- Target version set to Future
- Assigned To set to Brett Smith
Ensure all public classes, methods, and functions in the arvados.api
module have docstrings in our style.
- Description updated (diff)
- Target version changed from Future to To be scheduled
- Target version changed from To be scheduled to Development 2023-10-25 sprint
- Target version changed from Development 2023-10-25 sprint to Development 2023-10-11 sprint
- Status changed from New to In Progress
19818-api-pydoc @ e506be286860ea57065816465fd22c203b9b145a - developer-run-tests: #3839
Two commits. The first deprecates OrderedJsonModel
. See the commit message for details.
The second adds the rest of the documentation. One thing I did as part of it is move all the deprecated stuff to the bottom of the module. pdoc renders things in definition order, so this means it appears at the bottom of the web documentation too. That seems like a nice thing to do for readers. If it sounds good to you too, I'll add it to our coding guidelines.
- 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
- See above - the Workbench integration test failure can't possibly be real
- Documentation has been updated.
- Behaves appropriately at the intended scale (describe intended scale).
- Considered backwards and forwards compatibility issues between client and server.
- Yes, see first commit message
- Follows our coding standards and GUI style guidelines.
- Status changed from In Progress to Resolved
Also available in: Atom
PDF