Bug #22257: Provide more orientation in PySDK module pydocs - Arvados

Actions

Copy link

Bug #22257

closed

Provide more orientation in PySDK module pydocs

Added by Brett Smith 5 days ago. Updated 3 days ago.

Status:

Resolved

Priority:

Normal

Assigned To:

Brett Smith

Category:

Documentation

Target version:

Development 2024-11-06 sprint

Story points:

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.

Subtasks 1 (0 open — 1 closed)

Related issues

Actions

Copy link

Updated by Brett Smith 5 days ago

Has duplicate Bug #22259: pydoc should direct reader to api_resources added

Actions

Copy link

Updated by Brett Smith 4 days ago

Status changed from New to In Progress

22257-pydoc-api-xref @ a24298ab76c71fd3152d86997da925ddc03caff4 - developer-run-tests: #4529

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
- See above
Documentation has been updated.
- That's all this branch does
Behaves appropriately at the intended scale (describe intended scale).
- No change in scale
Considered backwards and forwards compatibility issues between client and server.
- No change in compatibility
Follows our coding standards and GUI style guidelines.
- Yes

Actions

Copy link

Updated by Peter Amstutz 3 days ago

Brett Smith wrote in #note-2:

22257-pydoc-api-xref @ a24298ab76c71fd3152d86997da925ddc03caff4 - developer-run-tests: #4529

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

See above

Documentation has been updated.

That's all this branch does

Behaves appropriately at the intended scale (describe intended scale).

No change in scale

Considered backwards and forwards compatibility issues between client and server.

No change in compatibility

Follows our coding standards and GUI style guidelines.

Yes