Idea #19830
closedWrite docstrings for arvados.util
Description
Ensure all public classes, methods, and functions in the arvados.util
module have docstrings in our style.
Related issues
Updated by Brett Smith almost 2 years ago
- Related to Idea #18800: Update Python SDK documentation added
Updated by Brett Smith almost 2 years ago
- Story points set to 0.5
- Description updated (diff)
Updated by Brett Smith over 1 year ago
- Target version changed from Future to To be scheduled
Updated by Peter Amstutz about 1 year ago
- Target version changed from To be scheduled to Development 2023-11-08 sprint
Updated by Peter Amstutz 12 months ago
- Target version changed from Development 2023-11-08 sprint to Development 2023-11-29 sprint
Updated by Peter Amstutz 11 months ago
- Target version changed from Development 2023-11-29 sprint to Development 2024-01-03 sprint
Updated by Brett Smith 11 months ago
- Target version changed from Development 2024-01-03 sprint to Development 2023-11-29 sprint
- Status changed from New to In Progress
Updated by Brett Smith 11 months ago
19830-pysdk-util-docs @ 65a84ec3801f6b76ccc2e6af07511851b4dc3aba - developer-run-tests: #3917
The type annotations adedd in this branch refer to `arvados.api_resources.ArvadosAPIRequest`. This class is added in the branch for #21132. I have tested and confirmed that pdoc will render these references correctly after #21132 is merged.
While working on that, I had a moment where I thought I was going to need to make some adjustments to `run_test_server.py`. Thankfully I walked away from that ledge. But I did get as far as cleaning the imports, and that's a simple nice change so we might as well keep it. That's included.
- All agreed upon points are implemented / addressed.
- Yes
- Anything not implemented (discovered or discussed during work) has a follow-up story.
- N/A
- Code is tested and passing, both automated and manual, what manual testing was done is described
- Yes, see above
- Documentation has been updated.
- N/A
- Behaves appropriately at the intended scale (describe intended scale).
- N/A
- Considered backwards and forwards compatibility issues between client and server.
- N/A
- Follows our coding standards and GUI style guidelines.
- Yes
Updated by Brett Smith 11 months ago
- % Done changed from 0 to 100
- Status changed from In Progress to Resolved
Applied in changeset arvados|442d78e1fb39f5d18f728f083e04f320ced44ebb.