changeset 38957:f356be1a7ba3

match: correct doc for _rootsdirsandparents after 5a7df82de142 Differential Revision: https://phab.mercurial-scm.org/D4159
author Kyle Lippincott <spectral@google.com>
date Wed, 08 Aug 2018 16:53:17 -0700
parents a3cabe9415e1
children b9f94d67ea73
files mercurial/match.py
diffstat 1 files changed, 5 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/match.py	Tue Jul 31 16:47:43 2018 -0700
+++ b/mercurial/match.py	Wed Aug 08 16:53:17 2018 -0700
@@ -1193,10 +1193,11 @@
 def _rootsdirsandparents(kindpats):
     '''Returns roots and exact directories from patterns.
 
-    roots are directories to match recursively, whereas exact directories should
-    be matched non-recursively. The returned (roots, dirs) tuple will also
-    include directories that need to be implicitly considered as either, such as
-    parent directories.
+    `roots` are directories to match recursively, `dirs` should
+    be matched non-recursively, and `parents` are the implicitly required
+    directories to walk to items in either roots or dirs.
+
+    Returns a tuple of (roots, dirs, parents).
 
     >>> _rootsdirsandparents(
     ...     [(b'glob', b'g/h/*', b''), (b'glob', b'g/h', b''),