From 44636240a08bba4a13355a5a23543d537ff15576 Mon Sep 17 00:00:00 2001 From: Stephan Creutz Date: Thu, 29 Dec 2022 14:50:43 +0100 Subject: Fix Sphinx rendering errors These errors are mostly fixed by either adding blank lines or single spaces for Sphinx documentation key words. The commit solely includes documentation changes, no functional changes. --- git/refs/log.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'git/refs/log.py') diff --git a/git/refs/log.py b/git/refs/log.py index a5f4de58..1f86356a 100644 --- a/git/refs/log.py +++ b/git/refs/log.py @@ -253,6 +253,7 @@ class RefLog(List[RefLogEntry], Serializable): def to_file(self, filepath: PathLike) -> None: """Write the contents of the reflog instance to a file at the given filepath. + :param filepath: path to file, parent directories are assumed to exist""" lfd = LockedFD(filepath) assure_directory_exists(filepath, is_file=True) @@ -326,6 +327,7 @@ class RefLog(List[RefLogEntry], Serializable): def write(self) -> "RefLog": """Write this instance's data to the file we are originating from + :return: self""" if self._path is None: raise ValueError("Instance was not initialized with a path, use to_file(...) instead") -- cgit v1.2.1