Project

General

Profile

Actions
Copy link

Story #19818

open

Write docstrings for arvados.api

Added by Brett Smith 6 months ago. Updated 4 months ago.

Status:
New
Priority:
Normal
Assigned To:
Brett Smith
Category:
Documentation
Target version:
To be scheduled
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
0.5

Description

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

Related issues

Related to Arvados Epics - Story #18800: Update Python SDK documentationIn Progress11/01/202207/31/2023

Actions
Actions
Copy link
 #1

Updated by Brett Smith 6 months ago

  • Related to Story #18800: Update Python SDK documentation added
Actions
Copy link
 #2

Updated by Brett Smith 6 months 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
Copy link
 #3

Updated by Peter Amstutz 5 months ago

  • Target version set to To be groomed
Actions
Copy link
 #4

Updated by Peter Amstutz 5 months ago

  • Assigned To set to Brett Smith
Actions
Copy link
 #5

Updated by Brett Smith 5 months 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
Copy link
 #6

Updated by Brett Smith 5 months ago

  • Description updated (diff)
Actions
Copy link
 #7

Updated by Brett Smith 4 months ago

  • Target version changed from To be groomed to To be scheduled
Actions
Copy link

Also available in: Atom PDF