1173633 - Display docstrings in mach help

Status: RESOLVED FIXED

(Firefox Build System :: Mach Core, enhancement)

Description

[Gregory Szorc [:gps]]

mach help could be made more useful if docstrings from mach command functions were displayed.

Comment 1

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1173633 - Print docstrings of mach command handlers in help output; r?ahal

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.

Comment 2

[Andrew Halberstadt [:ahal]]

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!

Comment 3

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/dd39dc238ef1

Comment 4

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/dd39dc238ef1