search

matejak / argbash

Bash argument parsing code generator
Other
1.39k stars 63 forks source link

Minor Typo in Generated Script comments for running argbash #97

Closed EdwardOst closed 5 years ago

EdwardOst commented 5 years ago

When I create a new script with argbash-init in fully decoupled mode it includes a helpful comment for running argbash on the resulting files to generate the script.

argbash-init -s -s --mode=full --pos positional-arg --opt option --opt-bool print myscript

Generates this comment in myscript

# Run 'argbash --library "myscript-parsing.sh" -o "myscript-parsing.sh"

But I think it is slightly wrong. I believe the comment should read

# Run 'argbash --library "myscript-parsing.m4" -o "myscript-parsing.sh"

The primary argument should be the .m4 specification file, not the script itself. (At least when running in fully decoupled mode.)

Also, it would be good to use the --strip user-content rather than --library to avoid the warning message.

matejak commented 5 years ago

Please check out your description again, the actual and suggested comments are the same, I believe that there is a typo.

EdwardOst commented 5 years ago

The suggested comment reference

myscript-parsing.m4

whereas the actual current comments specify

myscript-parsing.sh

matejak commented 5 years ago

Oh, I see, thanks!

matejak commented 5 years ago

@EdwardOst Could you please check the PR?