Apply suggestions from code review

Co-authored-by: Brett Cannon <[email protected]>

Author: Ovsyanka83

Doc/library/pathlib.rst

@@ -953,7 +953,7 @@ call fails (for example because the path doesn't exist).
 
    For each directory in the directory tree rooted at *self* (including
    *self* but excluding '.' and '..'), the method yields a 3-tuple of
-   ``(dirpath, dirnames, filenames)``
+   ``(dirpath, dirnames, filenames)``.
 
    *dirpath* is a :class:`Path` to the directory currently being walked,
    *dirnames* is a list of strings for the names of subdirectories in *dirpath*
@@ -963,27 +963,27 @@ call fails (for example because the path doesn't exist).
    ``dirpath / name``. Whether or not the lists are sorted is file
    system-dependent.
 
-   If optional argument *top_down* is true or not specified, the triple for a
+   If the optional argument *top_down* is true (which is the default), the triple for a
    directory is generated before the triples for any of its subdirectories
    (directories are walked top-down).  If *top_down* is false, the triple
    for a directory is generated after the triples for all of its subdirectories
    (directories are walked bottom-up). No matter the value of *top_down*, the
-   list of subdirectories is retrieved before the tuples for the directory and
+   list of subdirectories is retrieved before the triples for the directory and
    its subdirectories are walked.
 
    When *top_down* is true, the caller can modify the *dirnames* list in-place
-   (For example, using :keyword:`del` or slice assignment), and :meth:`Path.walk`
-   will only recurse into the subdirectories whose names remain in *dirnames*;
-   this can be used to prune the search, or to impose a specific order of visiting,
+   (for example, using :keyword:`del` or slice assignment), and :meth:`Path.walk`
+   will only recurse into the subdirectories whose names remain in *dirnames*.
+   This can be used to prune the search, or to impose a specific order of visiting,
    or even to inform :meth:`Path.walk` about directories the caller creates or
    renames before it resumes :meth:`Path.walk` again. Modifying *dirnames* when
-   *top_down* is false has no effect on the behavior of :meth:`Path.walk()`, since the
+   *top_down* is false has no effect on the behavior of :meth:`Path.walk()` since the
    directories in *dirnames* have already been generated by the time *dirnames*
    is yielded to the caller.
 
    By default, errors from :func:`os.scandir` are ignored.  If the optional
    argument *on_error* is specified, it should be a callable; it will be
-   called with one argument, an :exc:`OSError` instance. It can handle the
+   called with one argument, an :exc:`OSError` instance. The callable can handle the
    error to continue the walk or re-raise it to stop the walk. Note that the
    filename is available as the ``filename`` attribute of the exception object.
 
@@ -999,20 +999,19 @@ call fails (for example because the path doesn't exist).
       does not keep track of the directories it has already visited.
 
    .. note::
-      :meth:`Path.walk` assumes the directories it walks are not been modified during
+      :meth:`Path.walk` assumes the directories it walks are not modified during
       execution. For example, if a directory from *dirnames* has been replaced
       with a symlink and *follow_symlinks* is false, :meth:`Path.walk` will
       still try to descend into it. To prevent such behavior, remove directories
       from *dirnames* as appropriate.
 
    .. note::
 
-      Unlike :func:`os.walk`, :meth:`Path.walk` lists symlinks to directories into
+      Unlike :func:`os.walk`, :meth:`Path.walk` lists symlinks to directories in
       *filenames* if *follow_symlinks* is false.
 
    This example displays the number of bytes used by all files in each directory,
-   while ignoring ``__pycache__`` directories.
-   :file:`__pycache__` subdirectory::
+   while ignoring ``__pycache__`` directories::
 
       from pathlib import Path
       for root, dirs, files in Path("cpython/Lib/concurrent").walk(on_error=print):

Lib/test/test_pathlib.py

@@ -2479,15 +2479,6 @@ def test_complex_symlinks_relative_dot_dot(self):
         self._check_complex_symlinks(os.path.join('dirA', '..'))
 
 class WalkTests(unittest.TestCase):
-    """Tests for Path.walk()
-
-    They are mostly just copies of os.walk tests converted to use Paths
-    because os.walk tests are already mature and cover many edge cases
-    that we could miss writing new tests.
-
-    It is not combined with Path* tests because its setup is aimed at
-    testing a bit more complex cases than Path's setup.
-    """
 
     def setUp(self):
         P = pathlib.Path
@@ -2526,7 +2517,6 @@ def setUp(self):
         broken_link2_path = self.sub2_path / "broken_link2"
         broken_link3_path = self.sub2_path / "broken_link3"
 
-        # Create stuff.
         os.makedirs(self.sub11_path)
         os.makedirs(self.sub2_path)
         os.makedirs(sub21_path)
@@ -2548,7 +2538,7 @@ def setUp(self):
             self.sub2_tree = (self.sub2_path, ["SUB21"], ["tmp3"])
 
         if not is_emscripten:
-            # Emscripten fails with inaccessible directory
+            # Emscripten fails with inaccessible directories.
             os.chmod(sub21_path, 0)
         try:
             os.listdir(sub21_path)
@@ -2561,7 +2551,6 @@ def setUp(self):
             del self.sub2_tree[1][:1]
 
     def test_walk_topdown(self):
-        # Walk top-down.
         P = pathlib.Path
         all = list(self.walk_path.walk())
 
@@ -2585,7 +2574,6 @@ def test_walk_prune(self, walk_path=None):
         all = []
         for root, dirs, files in walk_path.walk():
             all.append((root, dirs, files))
-            # Don't descend into SUB1.
             if 'SUB1' in dirs:
                 # Note that this also mutates the dirs we appended to all!
                 dirs.remove('SUB1')
@@ -2601,7 +2589,6 @@ def test_file_like_path(self):
         self.test_walk_prune(FakePath(self.walk_path).__fspath__())
 
     def test_walk_bottom_up(self):
-        # Walk bottom-up.
         all = list(self.walk_path.walk( top_down=False))
 
         self.assertEqual(len(all), 4, all)
@@ -2623,7 +2610,6 @@ def test_walk_bottom_up(self):
 
     @os_helper.skip_unless_symlink
     def test_walk_follow_symlinks(self):
-        # Walk, following symlinks.
         walk_it = self.walk_path.walk(follow_symlinks=True)
         for root, dirs, files in walk_it:
             if root == self.link_path:
@@ -2634,14 +2620,15 @@ def test_walk_follow_symlinks(self):
             self.fail("Didn't follow symlink with follow_symlinks=True")
 
     def test_walk_symlink_location(self):
-        """ Tests whether symlinks end up in filenames or dirnames depending
-        on the `follow_symlinks` argument
-        """
+        # Tests whether symlinks end up in filenames or dirnames depending
+        # on the `follow_symlinks` argument.
         walk_it = self.walk_path.walk(follow_symlinks=False)
         for root, dirs, files in walk_it:
             if root == self.sub2_path:
                 self.assertIn("link", files)
                 break
+        else:
+            self.fail("symlink not found")
 
         walk_it = self.walk_path.walk(follow_symlinks=True)
         for root, dirs, files in walk_it:
@@ -2650,7 +2637,6 @@ def test_walk_symlink_location(self):
                 break
 
     def test_walk_bad_dir(self):
-        # Walk top-down.
         errors = []
         walk_it = self.walk_path.walk(on_error=errors.append)
         root, dirs, files = next(walk_it)