Summary

Fix up a few issues in RBTools docs.

Review Request #14220 — Created Oct. 31, 2024 and submitted Nov. 6, 2024, 8:27 a.m.

Information

Owner

david

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This fixes some problems I found while building the RBTools
documentation:

The command name listed for the patch command was incorrect, causing a
build failure.
The coderef entry for rbtools.commands.base had an extra trailing
period, causing warnings about being unable to find the module.
Several of the entries in the repository config doc had the wrong
characters for their heading underscore, leading to inconsistent
indentation in the TOC for that page.
Changed example .reviewboardrc settings to use code-block.
Fixed some typos.

Testing Done

Built and viewed documentation.

Commits

Summary	ID
Fix up a few issues in RBTools docs. This fixes some problems I found while building the RBTools documentation: - The command name listed for the patch command was incorrect, causing a build failure. - The coderef entry for `rbtools.commands.base` had an extra trailing period, causing warnings about being unable to find the module. - Several of the entries in the repository config doc had the wrong characters for their heading underscore, leading to inconsistent indentation in the TOC for that page. - Changed example .reviewboardrc settings to use `code-block`. - Fixed some typos. Testing Done: Built and viewed documentation.	f22321f7b3fab5f33d23eb724eb4c2142f4af881

Summary

Fix up a few issues in RBTools docs.

This fixes some problems I found while building the RBTools documentation: - The command name listed for the patch command was incorrect, causing a build failure. - The coderef entry for `rbtools.commands.base` had an extra trailing period, causing warnings about being unable to find the module. - Several of the entries in the repository config doc had the wrong characters for their heading underscore, leading to inconsistent indentation in the TOC for that page. - Changed example .reviewboardrc settings to use `code-block`. - Fixed some typos. Testing Done: Built and viewed documentation.

f22321f7b3fab5f33d23eb724eb4c2142f4af881

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Description:

~		This fixes three problems I found while building the RBTools
	~	This fixes some problems I found while building the RBTools
		documentation:

		The command name listed for the patch command was incorrect, causing a build failure.
		The coderef entry for `rbtools.commands.base` had an extra trailing period, causing warnings about being unable to find the module.
		Several of the entries in the repository config doc had the wrong characters for their heading underscore, leading to inconsistent indentation in the TOC for that page.
	+	Changed example .reviewboardrc settings to use `code-block`.
	+	Fixed some typos.

Commits:

	Summary	ID
	Fix up a few issues in RBTools docs. This fixes three problems I found while building the RBTools documentation: - The command name listed for the patch command was incorrect, causing a build failure. - The coderef entry for `rbtools.commands.base` had an extra trailing period, causing warnings about being unable to find the module. - Several of the entries in the repository config doc had the wrong characters for their heading underscore, leading to inconsistent indentation in the TOC for that page. Testing Done: Built and viewed documentation.	67c33a8d261c7a30cd1aedb3147ad84c24698477
	Fix up a few issues in RBTools docs. This fixes some problems I found while building the RBTools documentation: - The command name listed for the patch command was incorrect, causing a build failure. - The coderef entry for `rbtools.commands.base` had an extra trailing period, causing warnings about being unable to find the module. - Several of the entries in the repository config doc had the wrong characters for their heading underscore, leading to inconsistent indentation in the TOC for that page. - Changed example .reviewboardrc settings to use `code-block`. - Fixed some typos. Testing Done: Built and viewed documentation.	f22321f7b3fab5f33d23eb724eb4c2142f4af881

Diff:

Revision 2 (+288 -116)

Show changes

	docs/rbtools/api/coderef/index.rst
	docs/rbtools/rbt/commands/patch.rst
	docs/rbtools/rbt/configuration/repositories.rst
	docs/rbtools/rbt/configuration/users.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (40370ee)