Summary

Fix up documentation and typing for patcher code.

Review Request #14323 — Created Feb. 3, 2025 and submitted Feb. 10, 2025, 8:14 a.m.

Information

Owner

david

Repository

RBTools

Branch

master

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

The patcher code had several docstrings with errors of various sorts.
This change fixes up:

Some parameter names were listed incorrectly or were missing.
Some method names were not in the imperative mood.
A few typos.

This also adds type definitions for the can_commit and
can_patch_empty_files attributes for the SCMClientPatcher.

Testing Done

Ran unit tests.

Commits

Summary	ID
Fix up documentation and typing for patcher code. The patcher code had several docstrings with errors of various sorts. This change fixes up: - Some parameter names were listed incorrectly or were missing. - Some method names were not in the imperative mood. - A few typos. This also adds type definitions for the `can_commit` and `can_patch_empty_files` attributes for the `SCMClientPatcher`. Testing Done: Ran unit tests.	f734fd232086870ad31a4e45b14d6669372d9d50

Summary

Fix up documentation and typing for patcher code.

The patcher code had several docstrings with errors of various sorts. This change fixes up: - Some parameter names were listed incorrectly or were missing. - Some method names were not in the imperative mood. - A few typos. This also adds type definitions for the `can_commit` and `can_patch_empty_files` attributes for the `SCMClientPatcher`. Testing Done: Ran unit tests.

f734fd232086870ad31a4e45b14d6669372d9d50

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (8bda78d)