Actions
Idea #21211
closed
Add type annotations to documented PySDK modules
Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
11/21/2023
Due date:
Story points:
0.5
Release:
Release relationship:
Auto
Description
During #19821 we decided to add type annotations to our Python SDK purely as a documentation aid. Go back and add annotations to the modules that were documented before that:
- arvados.api
- arvados.retry
There should be type annotations in the docstrings, so this should just be a rote exercise of porting those to the older typing style.
Updated by Brett Smith 6 months ago
- Category set to Documentation
21211-pysdk-annotations @ 3fc85b18b18396d819e2a29a118985b794ed2e74 - developer-run-tests: #3919
- All agreed upon points are implemented / addressed.
- Yes. I also remembered that
arvados.safeapiis documented, so I annotated that too.
- Yes. I also remembered that
- 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
- 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
Updated by Brett Smith 5 months ago
- % Done changed from 0 to 100
- Status changed from New to Resolved
Applied in changeset arvados|9d33848deed3a044f5e6d086a19215b29e3c2847.
Actions