From: Stanley <46876382+slateny@users.noreply.github.com>
Date: Fri, 7 Oct 2022 22:51:50 +0000 (-0700)
Subject: gh-57179: Add note on symlinks for os.walk (#94799)
X-Git-Tag: v3.12.0a1~165
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0f498f1a95306995ca1e287f552c5c3d856be02d;p=thirdparty%2FPython%2Fcpython.git

gh-57179: Add note on symlinks for os.walk (#94799)
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 23b014b0b659..8727f811def1 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3222,7 +3222,8 @@ features:
    filenames)``.
 
    *dirpath* is a string, the path to the directory.  *dirnames* is a list of the
-   names of the subdirectories in *dirpath* (excluding ``'.'`` and ``'..'``).
+   names of the subdirectories in *dirpath* (including symlinks to directories,
+   and excluding ``'.'`` and ``'..'``).
    *filenames* is a list of the names of the non-directory files in *dirpath*.
    Note that the names in the lists contain no path components.  To get a full path
    (which begins with *top*) to a file or directory in *dirpath*, do
diff --git a/Lib/os.py b/Lib/os.py
index 648188e0f134..fd1e774fdcbc 100644
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -288,7 +288,8 @@ def walk(top, topdown=True, onerror=None, followlinks=False):
         dirpath, dirnames, filenames
 
     dirpath is a string, the path to the directory.  dirnames is a list of
-    the names of the subdirectories in dirpath (excluding '.' and '..').
+    the names of the subdirectories in dirpath (including symlinks to directories,
+    and excluding '.' and '..').
     filenames is a list of the names of the non-directory files in dirpath.
     Note that the names in the lists are just names, with no path components.
     To get a full path (which begins with top) to a file or directory in