How to add examples for verbs?

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
cli

Research direction

The issue provides no file, test, or entry point. Start by locating the Verb and HelpText attribute handling and compare how verb metadata is rendered; define the expected Example API and its displayed output before implementing, then add coverage showing examples can be attached to each verb.

Written by the indexing model from the issue text.

Description

I try to add examples for each verb i have.

Is something similar to below possible?

[Verb("stop", HelpText = "Stop....")]
[Example("Stop with custom timeout", "dustcli stop --timeout 5000")]
public class StopOptions { ...
Dominant language
C#
Stars
4.8k
Forks
478
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 commandlineparser/commandline

All issues in commandlineparser/commandline

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.