Project

General

Profile

Actions

Story #19792

open

Python SDK cookbook explains its examples better

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

Status:
In Progress
Priority:
Normal
Assigned To:
Category:
SDKs
Target version:
Start date:
01/02/2023
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)
Story points:
1.0

Description

The examples in the Python SDK cookbook are good illustrations of common tasks, but there isn't much in there to help the reader understand why the code is structured the way it is, or how they might adapt the code to their particular use case. Expand the cookbook to improve this situation.

  • Organize the recipes into related sections.
  • Add a preface to each recipe to detail what it does and give a use case for when you might want it.
  • Add comments to the code to explain tricky parts or suggest how to make common changes.
  • Structure the code to prioritize follow-ability. Use variable names that are as self-documenting as possible. Avoid doing multiple things on one line of code.

Subtasks 1 (1 open0 closed)

Task #19855: Review 19792-pysdk-cookbookIn ProgressSarah Zaranek01/02/2023

Actions

Related issues

Related to Arvados - Feature #6865: [Documentation] Higher Level Python SDK Reference PageNew08/03/2015

Actions
Actions #1

Updated by Peter Amstutz over 1 year ago

  • Target version set to 2022-12-07 Sprint
Actions #2

Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2022-12-07 Sprint to 2022-12-21 Sprint
Actions #3

Updated by Brett Smith over 1 year ago

  • Story points set to 1.0
Actions #4

Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2022-12-21 Sprint to 2023-01-18 sprint
Actions #5

Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2023-01-18 sprint to 2022-12-21 Sprint
Actions #6

Updated by Peter Amstutz over 1 year ago

  • Assigned To set to Brett Smith
Actions #7

Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2022-12-21 Sprint to 2023-01-18 sprint
Actions #8

Updated by Brett Smith over 1 year ago

  • Status changed from New to In Progress
Actions #9

Updated by Brett Smith over 1 year ago

  • Related to Feature #6865: [Documentation] Higher Level Python SDK Reference Page added
Actions #11

Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2023-01-18 sprint to 2023-02-01 sprint
Actions

Also available in: Atom PDF