Flesh out the documentation for ReviewRequestManager query functions.

Review Request #12340 — Created June 8, 2022 and submitted — Latest diff uploaded

Information

Review Board
release-5.0.x

Reviewers

The query functions in ReviewRequestManager are very old, and most
either lacked documentation or didn't meet current documentation
conventions.

As some work is being done in these functions, and given the importance
of these functions and their behavior, it's time to ensure they meet
documentation standards.

This updates the docstrings for all the query functions, making
behaviors and usage explicit.

No logic has changed.

Built the docs and checked through them. Didn't see anything
obvious or any build errors/warnings related to this file.

Diff Revision 2 (Latest)

orig
1
2

Commits

First Last Summary ID Author
Flesh out the documentation for ReviewRequestManager query functions.
The query functions in `ReviewRequestManager` are very old, and most either lacked documentation or didn't meet current documentation conventions. As some work is being done in these functions, and given the importance of these functions and their behavior, it's time to ensure they meet documentation standards. This updates the docstrings for all the query functions, making behaviors and usage explicit. No logic has changed.
6cceba85a82c9c7c993c047240239e398f0a55f1 Christian Hammond
reviewboard/reviews/managers.py
Loading...