Add documentation for the Extension and JSExtension classes.

Review Request #8513 — Created Oct. 31, 2016 and submitted

chipx86
Djblets
release-0.9.x
04dfbe8...
djblets

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)

reviewbotreviewbot

This should point out that this needs to be JSON-serializable.

daviddavid

set of what?

daviddavid

"parent package" is funky nomenclature. How about "the extension's python package metadata". This should probably also explain why you might …

daviddavid

It's kind of bizarre to suggest using a raw string here.

daviddavid

This isn't a list.

daviddavid

This isn't a list.

daviddavid
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        djblets/extensions/extension.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        djblets/extensions/extension.py
    
    
  2. djblets/extensions/extension.py (Diff revision 1)
     
     
    Col: 80
     E501 line too long (80 > 79 characters)
    
  3. 
      
david
  1. 
      
  2. djblets/extensions/extension.py (Diff revision 1)
     
     
     

    This should point out that this needs to be JSON-serializable.

  3. djblets/extensions/extension.py (Diff revision 1)
     
     

    set of what?

  4. 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.

  5. djblets/extensions/extension.py (Diff revision 1)
     
     

    It's kind of bizarre to suggest using a raw string here.

  6. djblets/extensions/extension.py (Diff revision 1)
     
     

    This isn't a list.

  7. djblets/extensions/extension.py (Diff revision 1)
     
     

    This isn't a list.

  8. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        djblets/extensions/extension.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        djblets/extensions/extension.py
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-0.9.x (6823215)
Loading...