Skip to content

Commit da771e0

Browse files
committed
Fix docstrings that intend '\' literally
This intended '\' literally, but it was actually '' because the \' became just ' (backslash-apostrophe becomes just aspostrophe).
1 parent 8107cbf commit da771e0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

git/objects/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ def name(self) -> str:
212212

213213
@property
214214
def abspath(self) -> PathLike:
215-
"""
215+
R"""
216216
:return:
217217
Absolute path to this index object in the file system ( as opposed to the
218218
.path field which is a path relative to the git repository ).

git/util.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ def stream_copy(source: BinaryIO, destination: BinaryIO, chunk_size: int = 512 *
223223

224224

225225
def join_path(a: PathLike, *p: PathLike) -> PathLike:
226-
"""Join path tokens together similar to osp.join, but always use
226+
R"""Join path tokens together similar to osp.join, but always use
227227
'/' instead of possibly '\' on windows."""
228228
path = str(a)
229229
for b in p:
@@ -261,7 +261,7 @@ def to_native_path_linux(path: PathLike) -> str:
261261

262262

263263
def join_path_native(a: PathLike, *p: PathLike) -> PathLike:
264-
"""
264+
R"""
265265
As join path, but makes sure an OS native path is returned. This is only
266266
needed to play it safe on my dear windows and to assure nice paths that only
267267
use '\'"""

0 commit comments

Comments
 (0)