commandlineparser/commandline

Extended help information

Open

#337 建立於 2018年9月26日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)C# (4,280 star) (461 fork)batch import
enhancementgood first issue

描述

I think that it would be nice if we could display additional text about application if someone types MyApp --help, and additional help for verb if someone types MyApp Verb --help.

I know there is HelpText property on BaseAttribute. It is nice for communicating what given option does, however I think that it is not suitable for extended, in-depth explanation. I would see it like that:

MyApp.exe help
MyApp 1.0.0
Copyright (C) 2018 MyApp 

  verb1    Help text for verb 1
  verb2    Help text for verb 2
  help             Display more information on a specific command.
  version          Display version information.

Long explanation about app

MyApp.exe help verb1
MyApp 1.0.0
Copyright (C) 2018 MyApp 

  verb1    Help text for verb 1
  verb2    Help text for verb 2
  help             Display more information on a specific command.
  version          Display version information.

Long explanation about verb1

貢獻者指南

技術棧
csharp
領域
clidocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
C# knowledgeFamiliarity with CommandLine library
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
Examine the existing HelpText property on BaseAttribute and the help text rendering logic. Look at files like HelpText.cs or similar in the source. The feature requires adding an ExtendedHelpText property to options/verbs, then modifying the help output to include the extended text after the command summary. Review the format shown in the issue to understand placement. Check if there are any linked PRs or comments that discuss implementation details.
Extended help information · commandlineparser/commandline#337 | Good First Issue