Add typing and docs for WebAPIResource configuration attributes.

Review Request #13276 — Created Sept. 19, 2023 and submitted

Information

Djblets
release-4.x

Reviewers

This updates WebAPIResource to add typing and documentation for the
attributes intended to be filled in when subclassing. This can help with
ensuring that subclasses properly configure new API resources.

There is the usual issue where some attributes (name, name_plural,
and some others) are defined as properties by default, and overriding
them causes issues with the type checker. This is a wider problem in how
we manage configuring subclasses, and won't be addressed as part of this
work.

Unit tests pass.

Summary ID
Add typing and docs for WebAPIResource configuration attributes.
This updates `WebAPIResource` to add typing and documentation for the attributes intended to be filled in when subclassing. This can help with ensuring that subclasses properly configure new API resources. There is the usual issue where some attributes (`name`, `name_plural`, and some others) are defined as properties by default, and overriding them causes issues with the type checker. This is a wider problem in how we manage configuring subclasses, and won't be addressed as part of this work.
38b51e7f3255abd716f42aa75ce118b98827aa28
david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-4.x (6f84c17)