Add codebase documentation for the core SCMTools classes.
Review Request #8314 — Created July 28, 2016 and submitted
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.
- Change Summary:
-
Added
.. deprecated
forbase_commit_id
. - Commit:
-
3ab45d67762be593faaab6255797c2b66207d55fc8d7af9a2a81345f55da63c7656c48cad2ac555b
- Diff:
-
Revision 2 (+823 -45)