From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 8 Oct 2022 03:15:08 +0000 (-0700)
Subject: gh-57179: Add note on symlinks for os.walk (GH-94799)
X-Git-Tag: v3.10.8~20
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1818235f402843db0fbeb21a7954b6ef209c916c;p=thirdparty%2FPython%2Fcpython.git

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

(cherry picked from commit 0f498f1a95306995ca1e287f552c5c3d856be02d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index c8bb5a902d81..58f01e97459c 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3135,7 +3135,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 d26cfc99939f..4f2ffceaaf38 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