search

rails / thor

Thor is a toolkit for building powerful command-line interfaces.
http://whatisthor.com/
MIT License
5.12k stars 553 forks source link

Documentation of Thor::Actions#initialize incomplete #727

Closed paddor closed 1 month ago

paddor commented 4 years ago

https://rubydoc.info/github/wycats/thor/master/Thor%2FActions:initialize says:

The actions default behavior. Can be :invoke or :revoke. It also accepts :force, :skip and :pretend to set the behavior and the respective option.

But there's not a word about what these options do. I can guess what :force and :pretend do with #copy_file, but not so with :skip.

rafaelfranca commented 4 years ago

The explanation is here https://github.com/erikhuda/thor/blob/34df888d721ecaa8cf0cea97d51dc6c388002742/lib/thor/actions.rb#L48-L60. Can you open a PR expanding the documentation?

azzenabidi commented 2 years ago

Hi @rafaelfranca, happy to work on this. Could you please point me to the relevant repo? Thanks! cc @paddor