From 0322ccc5486b5d1566cb0a595c49900196e52a92 Mon Sep 17 00:00:00 2001
From: Stanley <46876382+slateny@users.noreply.github.com>
Date: Fri, 7 Oct 2022 15:51:50 -0700
Subject: [PATCH] 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>
---
Doc/library/os.rst | 3 ++-
Lib/os.py | 3 ++-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index fbfeeb2d7e1f18..83377916691069 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -3208,7 +3208,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 648188e0f13490..fd1e774fdcbcfa 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