• 
      

    Add some documentation to our top-level modules.

    Review Request #7367 — Created June 2, 2015 and submitted

    Information

    Review Board
    release-2.5.x
    adf5e6b...

    Reviewers

    This adds documentation to the reviewboard, reviewboard.rb_platform, and
    reviewboard.signals modules. Most of these had docs already, but not in
    a format that would be picked up by Sphinx.

    The docstrings at the top of the files show up as summaries in the
    generated list of modules. The full details show up on the given module
    pages. As we go forward, we'll want to flesh out more module docstrings,
    to help guide contributors and developers through the relevant parts of
    the codebase.

    Built the docs. Saw the details on the module pages, and the summaries on
    the module listings.

    Description From Last Updated

    'reviewboard' imported but unused

    reviewbotreviewbot
    reviewbot
    1. Tool: PEP8 Style Checker
      Processed Files:
          reviewboard/signals.py
          reviewboard/rb_platform.py
          reviewboard/__init__.py
      
      
      
      Tool: Pyflakes
      Processed Files:
          reviewboard/signals.py
          reviewboard/rb_platform.py
          reviewboard/__init__.py
      
      
    2. reviewboard/__init__.py (Diff revision 1)
       
       
      Show all issues
       'reviewboard' imported but unused
      
    3. 
        
    david
    1. Ship It!
    2. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-2.5.x (b497a8e)