Support argument descriptions

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
cli

Research direction

Start at the ArgumentParser.schema API shown in the issue and trace how required arguments are stored and how command summaries are generated. Add support for the supplied descriptions and verify that generated command summaries include them; the issue does not name a test file, so locate the existing parser or summary tests first.

Written by the indexing model from the issue text.

Description

good first issue
# Define a parser with required arguments
parser = ArgumentParser.schema
  .required(:command, "The command to perform")
  .required(:target, "The target of the command")
  .build

This can be useful to generate command summaries

Dominant language
Ruby
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from thoughtbot/argument_parser

All issues in thoughtbot/argument_parser

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.