diff options
| author | Andre Delfino <adelfino@gmail.com> | 2020-12-17 01:37:28 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-17 01:37:28 (GMT) |
| commit | dcc997cd28ab33ebac44182ee55533c1b37689f7 (patch) | |
| tree | 1f3dad6d0fe646c4f3e5f3ca1219d88e2156383c /Doc/library/os.rst | |
| parent | c143cc379c7411598e7b7b652bac7935e4687d07 (diff) | |
| download | cpython-dcc997cd28ab33ebac44182ee55533c1b37689f7.zip cpython-dcc997cd28ab33ebac44182ee55533c1b37689f7.tar.gz cpython-dcc997cd28ab33ebac44182ee55533c1b37689f7.tar.bz2 | |
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
Diffstat (limited to 'Doc/library/os.rst')
| -rw-r--r-- | Doc/library/os.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index b309988..ab1a615 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -1991,7 +1991,7 @@ features: Accepts a :term:`path-like object`. -.. function:: lstat(path, \*, dir_fd=None) +.. function:: lstat(path, *, dir_fd=None) Perform the equivalent of an :c:func:`lstat` system call on the given path. Similar to :func:`~os.stat`, but does not follow symbolic links. Return a @@ -2498,7 +2498,7 @@ features: On the first, uncached call, a system call is required on Windows but not on Unix. - .. method:: is_dir(\*, follow_symlinks=True) + .. method:: is_dir(*, follow_symlinks=True) Return ``True`` if this entry is a directory or a symbolic link pointing to a directory; return ``False`` if the entry is or points to any other @@ -2522,7 +2522,7 @@ features: This method can raise :exc:`OSError`, such as :exc:`PermissionError`, but :exc:`FileNotFoundError` is caught and not raised. - .. method:: is_file(\*, follow_symlinks=True) + .. method:: is_file(*, follow_symlinks=True) Return ``True`` if this entry is a file or a symbolic link pointing to a file; return ``False`` if the entry is or points to a directory or other @@ -2552,7 +2552,7 @@ features: This method can raise :exc:`OSError`, such as :exc:`PermissionError`, but :exc:`FileNotFoundError` is caught and not raised. - .. method:: stat(\*, follow_symlinks=True) + .. method:: stat(*, follow_symlinks=True) Return a :class:`stat_result` object for this entry. This method follows symbolic links by default; to stat a symbolic link add the @@ -2584,7 +2584,7 @@ features: for :class:`bytes` paths on Windows. -.. function:: stat(path, \*, dir_fd=None, follow_symlinks=True) +.. function:: stat(path, *, dir_fd=None, follow_symlinks=True) Get the status of a file or a file descriptor. Perform the equivalent of a :c:func:`stat` system call on the given path. *path* may be specified as |