Skip to content

Commit

Permalink
Change _write to write in SubmoduleConfigParser docstring
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
EliahKagan committed Feb 27, 2024
1 parent 63c62ed commit 115451d
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions git/objects/submodule/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ def find_first_remote_branch(remotes: Sequence["Remote"], branch_name: str) -> "


class SubmoduleConfigParser(GitConfigParser):
"""Catches calls to _write, and updates the ``.gitmodules`` blob in the index
with the new data, if we have written into a stream.
"""Catches calls to :meth:`~git.config.GitConfigParser.write`, and updates the
``.gitmodules`` blob in the index with the new data, if we have written into a
stream.
Otherwise it would add the local file to the index to make it correspond with the
working tree. Additionally, the cache must be cleared.
Expand Down

0 comments on commit 115451d

Please sign in to comment.