shot-scraper icon indicating copy to clipboard operation
shot-scraper copied to clipboard

Reverse help arguments so Click recommends --help instead of -h

Open mbafford opened this issue 2 years ago • 0 comments

Change to make Click recommend --help instead of -h to avoid conflict with -h (--height) parameter.

I would probably remove -h entirely, but not sure how important maintaining that is.


This is trivial, but tripped me up.

Before this PR:

$ shot-scraper
Usage: shot-scraper shot [OPTIONS] URL
Try 'shot-scraper shot -h' for help.
[...]
$ shot-scraper shot
Usage: shot-scraper shot [OPTIONS] URL
Try 'shot-scraper shot -h' for help.
[...]

The recommendation is to run shot-scraper shot -h for help about the tool, but -h is actually the shortcut for "height":

$ shot-scraper shot -h
Error: Option '-h' requires an argument.
$ shot-scraper shot --help | grep -- -h
  -h, --height INTEGER   Height of browser window and shot - defaults to the

After this PR:

.env/bin/shot-scraper
Usage: shot-scraper shot [OPTIONS] URL
Try 'shot-scraper shot --help' for help.
[...]
$.env/bin/shot-scraper shot
Usage: shot-scraper shot [OPTIONS] URL
Try 'shot-scraper shot --help' for help.
[...]

:books: Documentation preview :books:: https://shot-scraper--84.org.readthedocs.build/en/84/

mbafford avatar Aug 03 '22 18:08 mbafford