More useful client docstrings and CLI help messages (Target: 15/25)
@voetberg is already working on this.
Since Apr 17, 2026.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
[Purposefully broad - hopefully this issue will spawn little child issues]
Much of the client and cli documentation gives a general idea of what something does but very little information about what that means or does - You can know how to call something but not what to do with it. In the words of the person who brought this concern to me: "You get about as much information as you would looking at the source code".
All descriptions can be improved by giving more information about the expected use-case or including lines like "used to x".
Critical examples include:
What is a lifetime model? Why would you want to add exceptions to it?
What's the difference between declaring something bad and quarantining a replica? Why would you ever do either?
Why would you add an identity instead of making a new account? What does the membership association get you?
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.
Assessment
This issue has not been assessed yet.