Project

General

Profile

Actions

Story #19792

open

Python SDK cookbook explains its examples better

Added by Brett Smith 11 days ago. Updated 2 days ago.

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

0%

Estimated time:
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.
Actions #1

Updated by Peter Amstutz 10 days ago

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

Updated by Peter Amstutz 9 days ago

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

Updated by Brett Smith 2 days ago

  • Story points set to 1.0
Actions

Also available in: Atom PDF