Repository navigation
Commit 115451d
committed
Change _write to write in SubmoduleConfigParser docstring
Since it appears to refer to the write method, which it overrides,
rather that the nonpublic _write method (which is not overridden,
and whose direct calls are not affected).1 parent 63c62ed commit 115451d
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -70,8 +70,9 @@ def find_first_remote_branch(remotes: Sequence["Remote"], branch_name: str) -> " | |||
| 70 | 70 | ||
| 71 | 71 | ||
| 72 | 72 | class SubmoduleConfigParser(GitConfigParser): | |
| 73 | - """Catches calls to _write, and updates the ``.gitmodules`` blob in the index | ||
| 74 | - with the new data, if we have written into a stream. | ||
| 73 | + """Catches calls to :meth:`~git.config.GitConfigParser.write`, and updates the | ||
| 74 | + ``.gitmodules`` blob in the index with the new data, if we have written into a | ||
| 75 | + stream. | ||
| 75 | 76 | ||
| 76 | 77 | Otherwise it would add the local file to the index to make it correspond with the | |
| 77 | 78 | working tree. Additionally, the cache must be cleared. | |
0 commit comments