Argument Clinic: add reference for the DSL
Open
Nobody has claimed this yet.
type-feature
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
We need a better reference for the Argument Clinic DSL:
- legal syntax for the "function name" line
- legal syntax for parameter lines
- legal syntax for docstrings
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 locating the existing Argument Clinic documentation and any current DSL references in the devguide. Compare the documented coverage with the requested function-name syntax, parameter-line syntax, and docstring syntax; the work is done when a reference explains the legal syntax for all three areas.
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
- Mostly clear
- Newbie friendliness
- 45/100