From 0fa1aa1975491533e970413fd6c66fc8a65f0cd3 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Thu, 9 Jun 2016 14:37:06 -0700 Subject: [PATCH] Clarify the os.fspath() documentation. --- Doc/library/os.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Doc/library/os.rst b/Doc/library/os.rst index deabaebe72..3dca86e473 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -188,11 +188,12 @@ process and user. .. function:: fspath(path) - Return the string representation of the path. + Return the file system representation of the path. If :class:`str` or :class:`bytes` is passed in, it is returned unchanged; - otherwise, the result of calling ``type(path).__fspath__`` is returned, or an - exception is raised. + otherwise, the result of calling ``type(path).__fspath__`` is returned + (which is represented by :class:`os.PathLike`). All other types raise a + :exc:`TypeError`. .. function:: getenv(key, default=None) -- 2.40.0