Consider adding the option names to the Command Syntax section on API pages
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Currently in the API pages the "Command syntax" labels the options only as options. This is probably a space-saving means for the main page, and that makes sense there. But I would rather see the options spelled out (including the defaults), as they are in the Python docs. For example I would like to see the connect Python page go from:
r.connect(options) → connection
to:
r.connect(host='localhost', port=28015, db='test', user='admin', password='', timeout=20, ssl=None) → connection
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
Start by comparing the API page for r.connect with the linked Python documentation example, then trace how the API-page "Command syntax" sections are produced. Review the other affected API pages and update their signatures to show option names and defaults; done means the displayed syntax is explicit and consistent with the Python docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100