gh-98832: Change wording in docstring of pathlib.Path.iterdir (GH-9…

…8833) Found while working on #98829 Automerge-Triggered-By: GH:AlexWaygood
python · Nov 9, 2022 · 87f5180 · 87f5180
1 parent 283ab0e
commit 87f5180
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/Lib/pathlib.py b/Lib/pathlib.py
@@ -867,8 +867,10 @@ def samefile(self, other_path):
         return os.path.samestat(st, other_st)
 
     def iterdir(self):
-        """Iterate over the files in this directory.  Does not yield any
-        result for the special paths '.' and '..'.
+        """Yield path objects of the directory contents.
+
+        The children are yielded in arbitrary order, and the
+        special entries '.' and '..' are not included.
         """
         for name in os.listdir(self):
             yield self._make_child_relpath(name)

diff --git a/Misc/NEWS.d/next/Documentation/2022-10-29-02-33-46.gh-issue-98832.DudEIH.rst b/Misc/NEWS.d/next/Documentation/2022-10-29-02-33-46.gh-issue-98832.DudEIH.rst
@@ -0,0 +1 @@
+Changes wording of docstring for :func:`pathlib.Path.iterdir`.