swift-argument-parser icon indicating copy to clipboard operation
swift-argument-parser copied to clipboard
verified publisher icon apple

[Sketch] Supplemental discussion

Open rauhul opened this issue 3 years ago • 4 comments

  • Idea: additional discussion for commands and arguments which is exported to dump-help and can be consumed by supplemental content generators to contains much more detailed information than you may want to include in a help screen. Maybe a better idea would be to have --help-detailed flag that would include this information in the help output. Suggestions are welcome.

rauhul avatar Aug 29 '22 03:08 rauhul

I'm kinda liking --help-detailed (--detailed-help) and renaming this property detailedDiscussion.

rauhul avatar Aug 29 '22 20:08 rauhul

I think --help-detailed makes a lot of sense! We could/should also detect when that's a reasonable option and add it to the help screen (along with --help-hidden when there are hidden args).

natecook1000 avatar Sep 23 '22 19:09 natecook1000

Hey! :wave: Is this skech pull request somehow related to https://github.com/apple/swift-argument-parser/issues/159?

arthurcro avatar Oct 01 '22 20:10 arthurcro

Hey! 👋 Is this skech pull request somehow related to #159?

Yep this would close that issue once fleshed out and merged.

rauhul avatar Oct 02 '22 20:10 rauhul