Fix some documentation errors for SCMTool.parse_diff_revision().

Review Request #11721 — Created July 15, 2021 and submitted — Latest diff uploaded

Information

Review Board
release-4.0.x

Reviewers

SCMTool.parse_diff_revision() documented the strings as Unicode
strings, when in fact they're required to be byte strings. It also
didn't have sufficient documentation for the return type.

All the subclasses had correct documentation. The problem was just in
SCMTool.

This is a small change that fixes up this documentation to be correct.
It actually copy/pastes the corrected docs used in subclasses.

Checked the documentation for errors.

Diff Revision 1 (Latest)

Commits

First Last Summary ID Author
Fix some documentation errors for SCMTool.parse_diff_revision().
`SCMTool.parse_diff_revision()` documented the strings as Unicode strings, when in fact they're required to be byte strings. It also didn't have sufficient documentation for the return type. All the subclasses had correct documentation. The problem was just in `SCMTool`. This is a small change that fixes up this documentation to be correct. It actually copy/pastes the corrected docs used in subclasses.
4b9d760db675d154745a4ac850442aa8b9fbf4b7 Christian Hammond
reviewboard/scmtools/core.py
Loading...