Summary

Add better doc support for multicommands.

Review Request #12133 — Created March 10, 2022 and submitted March 14, 2022, 3:51 p.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

The rbt-command-usage directive in our docs didn't handle the new
multi-commands very well (it would just print "rbt <subcommand>"). This
change extends it to rely on the commands' parser directly for
generating the help message, which improves the usage string, and adds a
list of available subcommands.

Testing Done

Built documentation and looked at the doc for rbt review.

Commits

Summary	ID
Add better doc support for multicommands. The `rbt-command-usage` directive in our docs didn't handle the new multi-commands very well (it would just print "rbt <subcommand>"). This change extends it to rely on the commands' parser directly for generating the help message, which improves the usage string, and adds a list of available subcommands. Testing Done: Built documentation and looked at the doc for `rbt review`.	43b1fa0cb3a867de472602ce9a3a939cbe5f2f6c

Summary

Add better doc support for multicommands.

The `rbt-command-usage` directive in our docs didn't handle the new multi-commands very well (it would just print "rbt <subcommand>"). This change extends it to rely on the commands' parser directly for generating the help message, which improves the usage string, and adds a list of available subcommands. Testing Done: Built documentation and looked at the doc for `rbt review`.

43b1fa0cb3a867de472602ce9a3a939cbe5f2f6c

Files

Issues

Description	From	Last Updated
I'm curious what this looks like. Can you put up a screenshot or something with an example of the new …	chipx86	March 14, 2022, 10:17 a.m.
Can you alphabetize these?	chipx86	March 14, 2022, 10:16 a.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

I'm curious what this looks like. Can you put up a screenshot or something with an example of the new docs?

docs/rbtools/_ext/rbt_commands.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can you alphabetize these?
```

Commits:

	Summary	ID
	Add better doc support for multicommands. The `rbt-command-usage` directive in our docs didn't handle the new multi-commands very well (it would just print "rbt <subcommand>"). This change extends it to rely on the commands' parser directly for generating the help message, which improves the usage string, and adds a list of available subcommands. Testing Done: Built documentation and looked at the doc for `rbt review`.	feb5622c6449fcf7ea3f2ca40e578f79b9d7ecbd
	Add better doc support for multicommands. The `rbt-command-usage` directive in our docs didn't handle the new multi-commands very well (it would just print "rbt <subcommand>"). This change extends it to rely on the commands' parser directly for generating the help message, which improves the usage string, and adds a list of available subcommands. Testing Done: Built documentation and looked at the doc for `rbt review`.	43b1fa0cb3a867de472602ce9a3a939cbe5f2f6c

Diff:

Revision 2 (+28 -16)

Show changes

docs/rbtools/_ext/rbt_commands.py

Added Files:

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (a495cf5)