Add codebase documentation for the core SCMTools classes.

Review Request #8314 — Created July 28, 2016 and submitted

Information

Review Board
release-2.5.x
c8d7af9...

Reviewers

People in the past have been confused as to what they need to override
or implement on SCMTool. A while back, I wrote documentation for most of
this, but never got it into a committable form. This finishes that work,
and brings it up to our current documentation standards.

All classes (SCMTool, Commit, Branch, etc.) and special Revisions in
reviewboard.scmtools.core are now documented, containing the
expectations for the consumers and subclasses, lists of expected
exceptions, and more.

Generated the docs and went through them, looking for broken links or
other obvious errors.

Description From Last Updated

Can we use .. deprecated here? I don't know if it will render correctly.

brenniebrennie

Likewise here.

brenniebrennie
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        reviewboard/scmtools/core.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        reviewboard/scmtools/core.py
    
    
  2. 
      
brennie
  1. 
      
  2. reviewboard/scmtools/core.py (Diff revision 1)
     
     

    Can we use .. deprecated here? I don't know if it will render correctly.

  3. reviewboard/scmtools/core.py (Diff revision 1)
     
     

    Likewise here.

  4. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        reviewboard/scmtools/core.py
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        reviewboard/scmtools/core.py
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-2.5.x (2b0d016)
Loading...