]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Changes to the documentation of normcase (GH-4725)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 14 May 2019 02:21:25 +0000 (19:21 -0700)
committerGitHub <noreply@github.com>
Tue, 14 May 2019 02:21:25 +0000 (19:21 -0700)
(cherry picked from commit 32d1458b2e2e00eeb29022179eeb04b83fb7f3c4)

Co-authored-by: Kexuan Sun <me@kianasun.com>
Doc/library/os.path.rst

index d78ab068a31ea37b72ab050204bcae28bc8a73d4..ef0e35d99867e7129bd78779c5de87ab17e976a8 100644 (file)
@@ -81,7 +81,7 @@ the :mod:`glob` module.)
 .. function:: commonpath(paths)
 
    Return the longest common sub-path of each pathname in the sequence
-   *paths*.  Raise ValueError if *paths* contains both absolute and relative
+   *paths*.  Raise :exc:`ValueError` if *paths* contains both absolute and relative
    pathnames, or if *paths* is empty.  Unlike :func:`commonprefix`, this
    returns a valid path.
 
@@ -315,9 +315,9 @@ the :mod:`glob` module.)
 
 .. function:: normcase(path)
 
-   Normalize the case of a pathname.  On Unix and Mac OS X, this returns the
-   path unchanged; on case-insensitive filesystems, it converts the path to
-   lowercase.  On Windows, it also converts forward slashes to backward slashes.
+   Normalize the case of a pathname.  On Windows, convert all characters in the
+   pathname to lowercase, and also convert forward slashes to backward slashes.
+   On other operating systems, return the path unchanged.
    Raise a :exc:`TypeError` if the type of *path* is not ``str`` or ``bytes`` (directly
    or indirectly through the :class:`os.PathLike` interface).