]> granicus.if.org Git - python/commitdiff
Clarify documentation for os.fspath().
authorBrett Cannon <brett@python.org>
Thu, 9 Jun 2016 21:32:08 +0000 (14:32 -0700)
committerBrett Cannon <brett@python.org>
Thu, 9 Jun 2016 21:32:08 +0000 (14:32 -0700)
Modules/clinic/posixmodule.c.h
Modules/posixmodule.c

index 158f94b73bc4b946f847b92eb1dbebb0e62b6685..33621d80d9f8404006805a5e6fcabf461c2084ce 100644 (file)
@@ -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]*/
index c55226576c9305693624597fff8a1ba775ce6733..f4510dbec9a08a93e98178cf0b1d3b73cfbeb1d4 100644 (file)
@@ -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);
 }