diff options
author | Brett Cannon <brett@python.org> | 2016-06-09 21:32:08 (GMT) |
---|---|---|
committer | Brett Cannon <brett@python.org> | 2016-06-09 21:32:08 (GMT) |
commit | b4f43e90d9a01b0e53f1b1b335f4946af6c193b1 (patch) | |
tree | d800cb353cd1b230bf834d6fa4d73d55969c9eae | |
parent | 5f74ebc2e4afd2f385b629e74700fec49c699b1f (diff) | |
download | cpython-b4f43e90d9a01b0e53f1b1b335f4946af6c193b1.zip cpython-b4f43e90d9a01b0e53f1b1b335f4946af6c193b1.tar.gz cpython-b4f43e90d9a01b0e53f1b1b335f4946af6c193b1.tar.bz2 |
Clarify documentation for os.fspath().
-rw-r--r-- | Modules/clinic/posixmodule.c.h | 8 | ||||
-rw-r--r-- | Modules/posixmodule.c | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/Modules/clinic/posixmodule.c.h b/Modules/clinic/posixmodule.c.h index 158f94b..33621d8 100644 --- a/Modules/clinic/posixmodule.c.h +++ b/Modules/clinic/posixmodule.c.h @@ -5486,9 +5486,9 @@ PyDoc_STRVAR(os_fspath__doc__, "\n" "Return the file system path representation of the object.\n" "\n" -"If the object is str or bytes, then allow it to pass through with\n" -"an incremented refcount. If the object defines __fspath__(), then\n" -"return the result of that method. All other types raise a TypeError."); +"If the object is str or bytes, then allow it to pass through as-is. If the\n" +"object defines __fspath__(), then return the result of that method. All other\n" +"types raise a TypeError."); #define OS_FSPATH_METHODDEF \ {"fspath", (PyCFunction)os_fspath, METH_VARARGS|METH_KEYWORDS, os_fspath__doc__}, @@ -5984,4 +5984,4 @@ exit: #ifndef OS_SET_HANDLE_INHERITABLE_METHODDEF #define OS_SET_HANDLE_INHERITABLE_METHODDEF #endif /* !defined(OS_SET_HANDLE_INHERITABLE_METHODDEF) */ -/*[clinic end generated code: output=31dd4f672c8a6f8c input=a9049054013a1b77]*/ +/*[clinic end generated code: output=1b91c3a100e75a4d input=a9049054013a1b77]*/ diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c index c552265..f4510db 100644 --- a/Modules/posixmodule.c +++ b/Modules/posixmodule.c @@ -12323,14 +12323,14 @@ os.fspath Return the file system path representation of the object. -If the object is str or bytes, then allow it to pass through with -an incremented refcount. If the object defines __fspath__(), then -return the result of that method. All other types raise a TypeError. +If the object is str or bytes, then allow it to pass through as-is. If the +object defines __fspath__(), then return the result of that method. All other +types raise a TypeError. [clinic start generated code]*/ static PyObject * os_fspath_impl(PyModuleDef *module, PyObject *path) -/*[clinic end generated code: output=51ef0c2772c1932a input=652c7c37e4be1c13]*/ +/*[clinic end generated code: output=51ef0c2772c1932a input=e357165f7b22490f]*/ { return PyOS_FSPath(path); } |