Python Client documentation is very minimal
Open
Nobody has claimed this yet.
component:st2client
documentation
stale
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
SUMMARY
Provide a quick summary of your bug or feature request.
ISSUE TYPE
- ReadMe update
EXPECTED RESULTS
More detailed readme for python client
ACTUAL RESULTS
Readme for python client is very minimal and insufficient for usage.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Python client's current README and review its existing usage guidance first. Expand the documentation with enough detail for users to understand how to use the client, then verify that the README is clear and complete for the expected usage scenarios.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100