Add and modernize documentation throughout WebAPIResource.

Review Request #13277 — Created Sept. 19, 2023 and submitted — Latest diff uploaded

Information

Djblets
release-4.x

Reviewers

WebAPIResource is a very old and complex part of our codebase, and
lacked any form of modern documentation. This made it more difficult to
iterate on, and with some upcoming work planned for this, it was time to
address this problem.

This change adds documentation to all the methods in the class, and sets
the stage for those upcoming changes.

Unit tests pass.

Built the docs. Verified there were no new errors in this module.

Diff Revision 2

This is not the most recent revision of the diff. The latest diff is revision 4. See what's changed.

orig
1
2
3
4

Commits

First Last Summary ID Author
Add and modernize documnentation throughout WebAPIResource.
`WebAPIResource` is a very old and complex part of our codebase, and lacked any form of modern documentation. This made it more difficult to iterate on, and with some upcoming work planned for this, it was time to address this problem. This change adds documentation to all the methods in the class, and sets the stage for those upcoming changes.
e0cfc7603aa26ad4c71df269b9d6043f31851754 Christian Hammond
djblets/webapi/resources/base.py
Loading...