mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-08 02:14:43 +00:00
67e6a15a08
`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. --HG-- extra : commitid : Hx6ZkHDxbCK extra : rebase_source : 01ced5a044442e370a45cd3fb245ac6283316925 extra : amend_source : fceb771e0e1ffa4e6f3f1b7c22eae6e25cf82034 |
||
|---|---|---|
| .. | ||
| docs | ||
| mach | ||
| bash-completion.sh | ||
| README.rst | ||
| setup.py | ||
==== mach ==== Mach (German for *do*) is a generic command dispatcher for the command line. To use mach, you install the mach core (a Python package), create an executable *driver* script (named whatever you want), and write mach commands. When the *driver* is executed, mach dispatches to the requested command handler automatically. To learn more, read the docs in ``docs/``.