Project

General

Profile

Actions

Story #18797

open

Flesh out python sdk documentation in docstrings & ensure good presentation in pydoc

Added by Peter Amstutz 6 months ago. Updated 6 months ago.

Status:
In Progress
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

Determine the capabilities & correct usage of pydoc for
  • text formatting
  • annotating function parameters
  • module-level docstrings
  • treatment of Py3 type annotations

Determine how to mark things as deprecated (documentation only, or possibly using decorators somehow)

Determine how to hide private variables/functions/classes from documentation (or possibly not export them at all, but need to be careful about backwards compatability)

Do some initial documentation samples and share with the team for feedback.

The goal is to update all documentation for public APIs in the Python SDK with correct formatting, deprecation markers, type annotations, etc. Also module-level docstrings to direct users to the correct classes for various topics.


Related issues

Related to Arvados - Support #18263: Plan to document the Python SDKResolvedPeter Amstutz

Actions
Related to Arvados Epics - Story #18800: Update Python SDK documentationNew06/01/202208/31/2022

Actions
Actions #1

Updated by Peter Amstutz 6 months ago

  • Status changed from New to In Progress
Actions #2

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #4

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #5

Updated by Peter Amstutz 6 months ago

  • Description updated (diff)
Actions #6

Updated by Peter Amstutz 6 months ago

Actions #7

Updated by Peter Amstutz 6 months ago

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

Also available in: Atom PDF