From: Martin v. Löwis <martin@v.loewis.de>
Date: Tue, 7 Oct 2008 06:36:31 +0000 (+0000)
Subject: Patch #3187 (file 11721): Document byte vs. string parameters
X-Git-Tag: v3.0rc2~89
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a731b9929f6aeb55d484cf7b655e9c108e16f222;p=python

Patch #3187 (file 11721): Document byte vs. string parameters
and results.
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 9e14003ac8..0fd4094e9e 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -693,13 +693,13 @@ Files and Directories
 
 .. function:: getcwd()
 
-   Return a bytestring representing the current working directory.
+   Return a string representing the current working directory.
    Availability: Unix, Windows.
 
 
-.. function:: getcwdu()
+.. function:: getcwdb()
 
-   Return a string representing the current working directory.
+   Return a bytestring  representing the current working directory.
    Availability: Unix, Windows.
 
 
@@ -801,8 +801,10 @@ Files and Directories
    ``'..'`` even if they are present in the directory. Availability:
    Unix, Windows.
 
-   On Windows NT/2k/XP and Unix, if *path* is a Unicode object, the result will be
-   a list of Unicode objects.
+   If *path* is a Unicode object, the result will be a list of Unicode objects.
+   If a filename can not be decoded to unicode, it is skipped. If *path* is a
+   bytes string, the result will be list of bytes objects included files
+   skipped by the unicode version.
 
 
 .. function:: lstat(path)
@@ -916,7 +918,9 @@ Files and Directories
    be converted to an absolute pathname using ``os.path.join(os.path.dirname(path),
    result)``.
 
-   If the *path* is a Unicode object, the result will also be a Unicode object.
+   If the *path* is an Unicode object, the result will also be a Unicode object
+   and may raise an UnicodeDecodeError. If the *path* is a bytes object, the
+   result will be a bytes object.
 
    Availability: Unix.