Closed Bug 1173633 Opened 5 years ago Closed 5 years ago
Display docstrings in mach help
40 bytes, text/x-review-board-request
mach help could be made more useful if docstrings from mach command functions were displayed.
Bug 1173633 - Print docstrings of mach command handlers in help output; r?ahal `mach help <command>` currently only displays a brief description of the command along with its arguments. Sometimes more detailed help text is needed. With this commit, the docstrings of mach command handlers will appear in the output of `mach help <command>` if they are defined. I've implemented basic docstrings for the three flavors of mach commands (normal command, main subcommand, subcommand) to demonstate things work. My hope is others will start to fill in docstrings once this feature lands so the output for `mach help` can serve as a better learning guide for new contributors.
Attachment #8620741 - Flags: review?(ahalberstadt)
Comment on attachment 8620741 [details] MozReview Request: Bug 1173633 - Print docstrings of mach command handlers in help output; r?ahal https://reviewboard.mozilla.org/r/10819/#review9487 Good idea!
Attachment #8620741 - Flags: review?(ahalberstadt) → review+
You need to log in before you can comment on or make changes to this bug.