dotnet/command-line-api

Examples of program usage

Open

#400 opened on Jan 30, 2019

View on GitHub
 (11 comments) (1 reaction) (0 assignees)C# (3,665 stars) (421 forks)auto 404
Area-Helpenhancementhelp wanted

Description

CommandLineParser supports of printing examples of program usage: There is examples ot this feature in BenchmarkDotNet:

https://github.com/dotnet/BenchmarkDotNet/blob/adde64cbbcde01938d6b2772066852c4f6c0e88d/src/BenchmarkDotNet/ConsoleArguments/CommandLineOptions.cs#L151-L178

Is there an equivalent of this function in `System.Command Line'?

Contributor guide

Tech stack
csharp
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic C#familiarity with System.CommandLine
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the BenchmarkDotNet example referenced in the issue (CommandLineOptions.cs lines 151-178) to understand how program usage examples are printed there. Investigate the current System.CommandLine help system in the repository to identify where similar functionality could be added, and consider proposing a design that mimics the approach used in BenchmarkDotNet.