Repository navigation
Commit 5219489
committed
Fix IndexObject.abspath docstring formatting
The original problem where the backslash wasn't included in the
docstring at all was fixed in 7dd2095 (#1725), but the backslash
still did not appear in rendered Sphinx documentation, because it
was also treated as a reStructuredText metacharacter.
Although that can be addressed by adding a further backslash to
escape it, the effect is ambiguous when the docstring is read in
the code. So this just encloses it in a double-backticked code
span instead, which is a somewhat clearer way to show it anyway.1 parent 115451d commit 5219489
1 file changed
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -226,7 +226,8 @@ def abspath(self) -> PathLike: | |||
| 226 | 226 | Absolute path to this index object in the file system (as opposed to the | |
| 227 | 227 | :attr:`path` field which is a path relative to the git repository). | |
| 228 | 228 | ||
| 229 | - The returned path will be native to the system and contains '\' on Windows. | ||
| 229 | + The returned path will be native to the system and contains ``\`` on | ||
| 230 | + Windows. | ||
| 230 | 231 | """ | |
| 231 | 232 | if self.repo.working_tree_dir is not None: | |
| 232 | 233 | return join_path_native(self.repo.working_tree_dir, self.path) | |
0 commit comments