Summary

Add code reference docs for the Review Bot worker.

Review Request #12142 — Created March 13, 2022 and submitted March 14, 2022, 1:54 p.m.

Information

Owner

chipx86

Repository

ReviewBot

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

This includes grouped sections for all parts of the Review Bot codebase
that might be relevant to tool developers or those working on/extending
existing tools.

In the process, some syntax errors and missing module docs were found.
These have been fixed.

Testing Done

Built the docs. Inspected all the module pages, and the links in the
main doc index.

Commits

Summary	ID
Add code reference docs for the Review Bot worker. This includes grouped sections for all parts of the Review Bot codebase that might be relevant to tool developers or those working on/extending existing tools. In the process, some syntax errors and missing module docs were found. These have been fixed.	653b9d61642c8f114ce2c09a57a3a032487fd62d

Issues

Description	From	Last Updated
E402 module level import not at top of file	reviewbot	March 13, 2022, 8:21 p.m.
E402 module level import not at top of file	reviewbot	March 13, 2022, 8:21 p.m.
F821 undefined name 'reviewboard'	reviewbot	March 13, 2022, 8:22 p.m.
E402 module level import not at top of file	reviewbot	March 13, 2022, 8:23 p.m.
E402 module level import not at top of file	reviewbot	March 13, 2022, 8:23 p.m.

flake8 failed.

JSHint passed.

flake8

docs/reviewbot/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
E402 module level import not at top of file
```
docs/reviewbot/conf.py (Diff revision 1)
The issue has been dropped. Show all issues
```
E402 module level import not at top of file
```
docs/reviewbot/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
F821 undefined name 'reviewboard'
```

Change Summary:

Fixed a bad import reference when building code links.

Commits:

	Summary	ID
	Add code reference docs for the Review Bot worker. This includes grouped sections for all parts of the Review Bot codebase that might be relevant to tool developers or those working on/extending existing tools. In the process, some syntax errors and missing module docs were found. These have been fixed.	f86be2d4398442183935055f37914b67c5ce6041
	Add code reference docs for the Review Bot worker. This includes grouped sections for all parts of the Review Bot codebase that might be relevant to tool developers or those working on/extending existing tools. In the process, some syntax errors and missing module docs were found. These have been fixed.	653b9d61642c8f114ce2c09a57a3a032487fd62d

Diff:

Revision 2 (+458 -44)

Show changes

	.gitignore
	bot/reviewbot/celery.py
	bot/reviewbot/config.py
	bot/reviewbot/repositories.py
	bot/reviewbot/tasks.py
	bot/reviewbot/tools/cargotool.py
	bot/reviewbot/tools/clang.py
	bot/reviewbot/tools/cppcheck.py
	13 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

docs/reviewbot/conf.py (Diff revision 2)
The issue has been dropped. Show all issues
```
E402 module level import not at top of file
```
docs/reviewbot/conf.py (Diff revision 2)
The issue has been dropped. Show all issues
```
E402 module level import not at top of file
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (7d23247)

docs/reviewbot/conf.py (Diff revision 1)

docs/reviewbot/conf.py (Diff revision 1)

docs/reviewbot/conf.py (Diff revision 1)

docs/reviewbot/conf.py (Diff revision 2)