Actions
Story #19792
openPython SDK cookbook explains its examples better
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.
Updated by Peter Amstutz about 2 years ago
- Target version set to 2022-12-07 Sprint
Updated by Peter Amstutz about 2 years ago
- Target version changed from 2022-12-07 Sprint to 2022-12-21 Sprint
Updated by Peter Amstutz about 2 years ago
- Target version changed from 2022-12-21 Sprint to 2023-01-18 sprint
Updated by Peter Amstutz about 2 years ago
- Target version changed from 2023-01-18 sprint to 2022-12-21 Sprint
Updated by Peter Amstutz almost 2 years ago
- Target version changed from 2022-12-21 Sprint to 2023-01-18 sprint
Updated by Brett Smith almost 2 years ago
- Status changed from New to In Progress
Updated by Brett Smith almost 2 years ago
- Related to Feature #6865: [Documentation] Higher Level Python SDK Reference Page added
Updated by Peter Amstutz almost 2 years ago
- Target version changed from 2023-01-18 sprint to 2023-02-01 sprint
Actions