Project

General

Profile

Actions

Idea #21211

closed

Add type annotations to documented PySDK modules

Added by Brett Smith 5 months ago. Updated 5 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Story points:
0.5
Release relationship:
Auto

Description

During #19821 we decided to add type annotations to our Python SDK purely as a documentation aid. Go back and add annotations to the modules that were documented before that:

  • arvados.api
  • arvados.retry

There should be type annotations in the docstrings, so this should just be a rote exercise of porting those to the older typing style.


Subtasks 1 (1 open0 closed)

Task #21213: Review 21211-pysdk-annotationsIn ProgressBrett Smith11/21/2023Actions
Actions #1

Updated by Brett Smith 5 months ago

  • Category set to Documentation

21211-pysdk-annotations @ 3fc85b18b18396d819e2a29a118985b794ed2e74 - developer-run-tests: #3919

  • All agreed upon points are implemented / addressed.
    • Yes. I also remembered that arvados.safeapi is documented, so I annotated that too.
  • 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.
    • N/A
  • Behaves appropriately at the intended scale (describe intended scale).
    • N/A
  • Considered backwards and forwards compatibility issues between client and server.
    • N/A
  • Follows our coding standards and GUI style guidelines.
    • Yes
Actions #2

Updated by Lucas Di Pentima 5 months ago

This LGTM, thanks.

Actions #3

Updated by Brett Smith 5 months ago

  • % Done changed from 0 to 100
  • Status changed from New to Resolved
Actions #4

Updated by Brett Smith 5 months ago

  • Release set to 67
Actions

Also available in: Atom PDF