Skip to content

Commit

Permalink
Fix docstrings that intend '\' literally
Browse files Browse the repository at this point in the history
This intended '\' literally, but it was actually '' because the \'
became just ' (backslash-apostrophe becomes just aspostrophe).
  • Loading branch information
EliahKagan committed Oct 22, 2023
1 parent 198548f commit 7dd2095
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion git/objects/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ def name(self) -> str:

@property
def abspath(self) -> PathLike:
"""
R"""
:return:
Absolute path to this index object in the file system ( as opposed to the
.path field which is a path relative to the git repository ).
Expand Down
4 changes: 2 additions & 2 deletions git/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def stream_copy(source: BinaryIO, destination: BinaryIO, chunk_size: int = 512 *


def join_path(a: PathLike, *p: PathLike) -> PathLike:
"""Join path tokens together similar to osp.join, but always use
R"""Join path tokens together similar to osp.join, but always use
'/' instead of possibly '\' on windows."""
path = str(a)
for b in p:
Expand Down Expand Up @@ -277,7 +277,7 @@ def to_native_path_linux(path: PathLike) -> str:


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

0 comments on commit 7dd2095

Please sign in to comment.