Skip to content

Not all options listed in OptionParser have optional arguments #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
olleolleolle opened this issue Mar 23, 2021 · 0 comments · Fixed by #946
Closed

Not all options listed in OptionParser have optional arguments #945

olleolleolle opened this issue Mar 23, 2021 · 0 comments · Fixed by #946
Labels
good-first-issue help wanted

Comments

@olleolleolle
Copy link
Collaborator

Describe the bug

The listed options are routinely shown as having --optname [FLORP] where FLORP is now described as optional argument to the --optname.

This is a docs problem, since many of these require a value to work correctly.

To Reproduce
Steps to reproduce the behavior:

  1. Go to lib/github_changelog_generator/parser.rb
  2. Read the individual options defined
  3. See issue that many are [OPTIONAL-VALUE] when they should not.

Expected behavior

--help output which matches what is true for option arity.

Additional context

This is a ✨ 📖 DOCUMENTATION ISSUE 📖 ✨ .
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good-first-issue help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update help output to reflect required args.
1 participant
@olleolleolle