Feature Request: Add Examples section in HelpBuilder.
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
先阅读 HelpBuilder 和 CliCommand API，然后查看链接的“Add or replace help sections”文章，以了解预期的扩展点。定义如何为每个命令配置一个 string 类型的 Examples 属性，并将其呈现为单独的帮助部分。完成标准是生成的帮助包含 examples 部分，同时保留现有的 description、usage 和 options 输出。
由索引模型根据 Issue 内容生成。
描述
The current help is generated based on the Description of Command/Option or Argument.
Most of cli tools provide examples in help.
It is needed to add a separate section appended to the current generated help for every Command.
The Examples can be a string property (like Description) in CliCommand to be used in configuring help examples every command.
In the article Add or replace help sections, we can add a new section , but it need to access a property Eg Examples
It is nice of that ExampleSection be part of HelpBuilder class .
Sample of the help with examples:
Description:
Read a file
Usage:
scl [options]
Options:
--file <file> The file to print out. [default: scl.runtimeconfig.json]
--light-mode Determines whether the background color will be black or
white
--color Specifies the foreground color of console output
<Black|Blue|Cyan|White>
--version Show version information
-?, -h, --help Show help and usage information
Examples:
Example 1:
scl --file file.txt --color Cyan
Example 2: Using default color
scl --file file.txt
- 主要语言
- C#
- 星标
- 3.7k
- 派生
- 436
- 平均合并
- 6 小时 27 分钟
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
dotnet/command-line-api 的其他 Issue
-
German localization is incomplete可能已有人在做 @b-v-d-e-v 于 24 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
dotnet/command-line-api#2852 ·
维护者通常 1 天内回复
-
Incomplete French (fr) translation: RequiredOptionWasNotProvided not translated可能已有人在做 @JPBlanc 于 122 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
dotnet/command-line-api#2822 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
dotnet/command-line-api#2792 · 2 条评论 · 17 个 reaction ·
维护者通常 1 天内回复
-
`Argument.Arity` modify internal state on first get access.可能已有人在做 @zjdangge 于 9 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
dotnet/command-line-api#2704 ·
维护者通常 1 天内回复
-
GetCompletions should check exit code of invoked application可能已有人在做 @baradgur 于 1293 天前认领。 未关闭Area-Completions bug help wanted
难度 2/5 1-3 小时 新手友好度 72/100
dotnet/command-line-api#2137 · 1 条评论 · 3 个 reaction ·
维护者通常 1 天内回复
查看 dotnet/command-line-api 的全部 Issue
相似的 Issue
-
track:release
难度 2/5 1-3 小时 新手友好度 80/100
-
[Bug] [Go] Ack returns nil when the server answers with a non-OK status可能已有人在做 @leizhiyuan 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
apache/rocketmq-clients#1465 ·
维护者通常 2 天内回复
-
fix(testing): HeadlessTerminal disposes services synchronously可能已有人在做 @zidad 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 69/100
RazorConsole/RazorConsole#388 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 72/100
starlinghq/starling#209 ·
维护者通常 1 天内回复