click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

fix: when `show_default` is a string use it as the default description #50

Closed muggenhor closed 4 years ago

muggenhor commented 4 years ago

Because this value doesn't just function as a boolean. When it's a string it's intended to allow the user to override the documentation of the default.

This parameter's alternative value is documented in https://click.palletsprojects.com/en/7.x/api/?highlight=show_default#click.Option

codecov-io commented 4 years ago

Codecov Report

Merging #50 into master will decrease coverage by 17.2%. The diff coverage is 66.66%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master      #50       +/-   ##
===========================================
- Coverage    71.9%   54.69%   -17.21%     
===========================================
  Files           1        1               
  Lines         210      298       +88     
  Branches       57      105       +48     
===========================================
+ Hits          151      163       +12     
- Misses         50      128       +78     
+ Partials        9        7        -2
Impacted Files Coverage Δ
sphinx_click/ext.py 54.69% <66.66%> (-17.21%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 09c3fa9...9cc3396. Read the comment docs.

stephenfin commented 4 years ago

Thanks. This has been released as part of 2.3.0.

muggenhor commented 4 years ago

Thanks for merging this so quickly :-)