mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-19 08:15:31 +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 |
||
---|---|---|
.. | ||
bitstring | ||
blessings | ||
compare-locales | ||
configobj | ||
eme | ||
jsmin | ||
lldbutils | ||
mach | ||
mock-1.0.0 | ||
mozboot | ||
mozbuild | ||
mozversioncontrol/mozversioncontrol | ||
psutil | ||
pyasn1 | ||
pyasn1-modules | ||
pystache | ||
pyyaml | ||
redo | ||
requests | ||
rsa | ||
virtualenv | ||
which | ||
mach_commands.py | ||
moz.build | ||
README |
This directory contains common Python code. The basic rule is that if Python code is cross-module (that's "module" in the Mozilla meaning - as in "module ownership") and is MPL-compatible, it should go here. What should not go here: * Python that is not MPL-compatible (see other-licenses/) * Python that has good reason to remain close to its "owning" (Mozilla) module (e.g. it is only being consumed from there). Historical information can be found at https://bugzilla.mozilla.org/show_bug.cgi?id=775243 ## pyyaml | pystache Used in taskcluster related mach commands to update download from github and remove .git and tests. Then run tests in taskcluster/tests/