Document existing parser fully
Open
docs
parsing
- Dominant language
- Python
- Stars
- 17.7k
- Forks
- 2.3k
- Avg merge
- 1d 30m
- Merged PRs (30d)
- 18
Description
The existing Click API is very large and a lot of edge cases are undocumented. Additionally there are lots of combinations between parameters and options.
I am not sure what is the best way to document all the combinations. There are enough combinations that it is hard to remember them all. Maybe a table with with tests that correlate to the table entry?
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.