Project

General

Profile

Actions

Idea #19826

closed

Write docstrings for arvados module

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

Status:
Closed
Priority:
Normal
Assigned To:
Category:
Documentation
Start date:
Due date:
Story points:
0.5

Description

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

Most of these functions will probably be marked deprecated, as they support the old jobs+tasks Crunch API. Our style describes how to do this.


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 Peter Amstutz over 1 year ago

  • Release set to 59
Actions #3

Updated by Peter Amstutz over 1 year ago

  • Target version set to To be scheduled
Actions #4

Updated by Brett Smith over 1 year ago

  • Description updated (diff)
Actions #5

Updated by Peter Amstutz 9 months ago

  • Target version changed from To be scheduled to Development 2024-01-03 sprint
Actions #6

Updated by Brett Smith 7 months ago

  • Target version changed from Development 2024-01-03 sprint to Development 2023-11-29 sprint
  • Assigned To set to Brett Smith
  • Status changed from New to Closed

Most of this got done in #20893 as part of the 2.7 deprecation work. After that all that was left was a module docstring, which got done in #19830 for implementation history reasons.

Actions

Also available in: Atom PDF