Add help message comments for constraints
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 259
- Forks
- 35
- PR merge metrics
- No merged PRs in 30d
Description
From https://github.com/ManageIQ/optimist/pull/130#issuecomment-1100475979, @nanobowers wrote:
> ...should there any default notation in the help message for exclusivity clauses? If the developer uses either:, conflicts: or depends, seems like the only good way to find out is to try it and get an error message, or the developer would have to manually note it with the banner message.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the discussion in https://github.com/ManageIQ/optimist/pull/130#issuecomment-1100475979 and trace how either:, conflicts:, and depends constraints are represented and rendered in help output. Clarify the desired notation and update the relevant help-generation path so users can discover exclusivity clauses without triggering an error; done means the help message communicates these constraints consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100