Summary

Fix some documentation errors for SCMTool.parse_diff_revision().

Review Request #11721 — Created July 15, 2021 and submitted July 16, 2021, 1:19 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

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.

Testing Done

Checked the documentation for errors.

Commits

Summary	ID
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

Summary

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

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.0.x (fb73ccf)