Skip to content
This repository has been archived by the owner on Nov 13, 2021. It is now read-only.

Document write option in a better way #101

Open
schultyy opened this issue Aug 24, 2016 · 1 comment
Open

Document write option in a better way #101

schultyy opened this issue Aug 24, 2016 · 1 comment

Comments

@schultyy
Copy link
Member

schultyy commented Aug 24, 2016

Right now it's not 100% obvious what needs to be passed to -w as an argument. The help text says (default: yes if CI is set, otherwise no). but it took me some time to figure that out after looking at it after some time.
My proposal would be to explicitly say what needs to be passed for the W param here:

  -w W, --write=yes/no        Write changes to files (default: yes if CI is set, otherwise no).

We need to check what docopt actually allows here as valid values.

This should also be mentioned in the README as well.

@emig
Copy link
Contributor

emig commented Aug 24, 2016

I see the following alternatives to that command, not using arguments:

  • -y
    Yes (without argument). Authorize potentially destructive actions for which the program would normally require confirmation. Examples: fsck(1), rz(1). this idea is taken from http://catb.org/~esr/writings/taoup/html/ch10s05.html and follows over time, frequently-used options in well-known Unix programs.
  • -w --write (without argument)

ghost pushed a commit that referenced this issue Nov 19, 2016
doc: document -w option in a better way

`-w` needs a value to be passed.

Related to #101
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants