maliput / maliput/maliput_integration
Add usage string to applications
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Desired behavior
Applications should have a usage string providing a description of what they do, the main flags and an a sample execution.
## Alternatives considered
N/A
## Implementation suggestion
Use `gflags::SetUsageMessage(kUsageMessage)` before calling `gflags::ParseCommandLineFlags(&argc, &argv, true)` in the applications where `kUsageMessage` is a constexpr string.
## Additional context
See this [comment](https://github.com/maliput/maliput_integration/pull/139#discussion_r1770598856).
Contributor guide
No contributing guide indexed for this repository
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
Locate the applications that call gflags::ParseCommandLineFlags and review the discussion linked from pull request 139. Add a constexpr usage string for each application and call gflags::SetUsageMessage before parsing the flags. Done means each application exposes its description, main flags, and a sample invocation in its usage output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100