search

carlobaldassi / ArgParse.jl

Package for parsing command-line arguments to Julia programs.
Other
231 stars 36 forks source link

Clarification about options and flags in the docs #87

Closed henriquebecker91 closed 4 years ago

henriquebecker91 commented 4 years ago

Hey,

I like your package and it has helped me a lot, but I think part of the documentation confused me and I ended up frustrated with options giving me unitary vectors until I understood better: the distinction between options and flags; the importance of the action field in distinguishing between the two.

This commit just adds a paragraph to make 100% explicit the difference/relationship between options and flags, and changes a part of the documentation where I think the term 'flag' was used in place of 'option' (which caused me confusion). The '-like' in flag-like and non-flag-like was also not helping (why flag-like? it IS a flag by the definition of 'flag' that is provided, and the context was not related to parsing, so it was not discussing if it some token appeared to be a flag or not to the parser).

carlobaldassi commented 4 years ago

Thanks!

henriquebecker91 commented 4 years ago

XD, it should be me thanking you for accepting so fast and developing this package.

Em dom., 19 de jan. de 2020 às 18:21, Carlo Baldassi < notifications@github.com> escreveu:

Thanks!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/carlobaldassi/ArgParse.jl/pull/87?email_source=notifications&email_token=ADLVVG5A27X553264RGWDMDQ6S74FA5CNFSM4KIVBVI2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEJK44IY#issuecomment-576048675, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADLVVGYBZ62SEAAMOYTCLU3Q6S74FANCNFSM4KIVBVIQ .