Add documentation for the Extension and JSExtension classes.
Review Request #8513 — Created Oct. 31, 2016 and submitted
These classes are pretty important, but we didn't have any real class
reference documentation for the attributes. This change introduces
documentation for these, fleshes out some of the docs for methods, and
updates one of the attributes to be a documentable@cached_property
(using Djblets's new, smarter version).Something worth noting is that Sphinx does not provide documentation
inheritance for attribute docs, so the Review Board documentation still
won't have those documented, but at least we have a good reference now
in Djblets.
Built the docs and looked through them. Everything was documented.
| Description | From | Last Updated |
|---|---|---|
|
Col: 80 E501 line too long (80 > 79 characters) |
 reviewbot
|
|
|
This should point out that this needs to be JSON-serializable. |
 david
|
|
|
set of what? |
david
|
|
|
"parent package" is funky nomenclature. How about "the extension's python package metadata". This should probably also explain why you might … |
david
|
|
|
It's kind of bizarre to suggest using a raw string here. |
david
|
|
|
This isn't a list. |
david
|
|
|
This isn't a list. |
david
|
-
-
djblets/extensions/extension.py (Diff revision 1) This should point out that this needs to be JSON-serializable.
-
-
djblets/extensions/extension.py (Diff revision 1) "parent package" is funky nomenclature. How about "the extension's python package metadata".
This should probably also explain why you might want to do this, such as having a displayed name with a space in it.
-
djblets/extensions/extension.py (Diff revision 1) It's kind of bizarre to suggest using a raw string here.
-
-
Change Summary:
- Fixed some wording to be more clear to a few different docstrings.
- Fixed information on some types.
- Added examples of when you'd define custom package metadata.
- Changed a regex in docs to use Sphinx's
:regexp:.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+189 -22) |
Tool: Pyflakes Processed Files: djblets/extensions/extension.py Tool: PEP8 Style Checker Processed Files: djblets/extensions/extension.py