click icon indicating copy to clipboard operation
click copied to clipboard
verified publisher icon pallets

Document existing parser fully

Open Rowlando13 opened this issue 11 months ago • 2 comments

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?

Rowlando13 avatar Jan 06 '25 08:01 Rowlando13

The test suite is getting better. May have an idea for splitting into situations and kwargs.

Rowlando13 avatar Aug 27 '25 06:08 Rowlando13

The reference docs per situation are decent for options, arguments, and parameters sections.

Rowlando13 avatar Aug 27 '25 06:08 Rowlando13