Project

General

Profile

Actions

Idea #19818

closed

Write docstrings for arvados.api

Added by Brett Smith over 1 year ago. Updated 7 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Start date:
09/29/2023
Due date:
Story points:
0.5
Release relationship:
Auto

Description

Ensure all public classes, methods, and functions in the arvados.api module have docstrings in our style.


Subtasks 1 (0 open1 closed)

Task #21009: Review 19818-api-pydocResolvedLucas Di Pentima09/29/2023Actions

Related issues

Related to Arvados Epics - Idea #18800: Update Python SDK documentationIn ProgressActions
Actions #1

Updated by Brett Smith over 1 year ago

  • Related to Idea #18800: Update Python SDK documentation added
Actions #2

Updated by Brett Smith over 1 year ago

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.

Actions #3

Updated by Peter Amstutz over 1 year ago

  • Target version set to Future
Actions #4

Updated by Peter Amstutz over 1 year ago

  • Assigned To set to Brett Smith
Actions #5

Updated by Brett Smith over 1 year ago

  • Story points set to 0.5

Ensure all public classes, methods, and functions in the arvados.api module have docstrings in our style.

Actions #6

Updated by Brett Smith over 1 year ago

  • Description updated (diff)
Actions #7

Updated by Brett Smith over 1 year ago

  • Target version changed from Future to To be scheduled
Actions #8

Updated by Peter Amstutz 8 months ago

  • Target version changed from To be scheduled to Development 2023-10-25 sprint
Actions #9

Updated by Peter Amstutz 8 months ago

  • Target version changed from Development 2023-10-25 sprint to Development 2023-10-11 sprint
Actions #10

Updated by Brett Smith 8 months ago

  • 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.
    • 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 - the Workbench integration test failure can't possibly be real
  • Documentation has been updated.
    • Yes
  • Behaves appropriately at the intended scale (describe intended scale).
    • N/A
  • Considered backwards and forwards compatibility issues between client and server.
    • Yes, see first commit message
  • Follows our coding standards and GUI style guidelines.
    • Yes
Actions #11

Updated by Lucas Di Pentima 8 months ago

This LGTM, thanks!

Actions #12

Updated by Brett Smith 8 months ago

  • Status changed from In Progress to Resolved
Actions #13

Updated by Peter Amstutz 7 months ago

  • Release set to 67
Actions

Also available in: Atom PDF