Merge pull request #172 from zaneb/group_regex-docs

Clarify docs on group_regex
mtreinish · May 30, 2018 · 8a8db7c · 8a8db7c
2 parents 9d503e7 + 2d97257
commit 8a8db7c
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/doc/source/MANUAL.rst b/doc/source/MANUAL.rst
@@ -319,10 +319,11 @@ And then find tests with that tag::
 Grouping Tests
 --------------
 
-In certain scenarios you may want to group tests of a certain type together
-so that they will be run by the same worker process. The group_regex option in
-the stestr config file permits this. When set, tests are grouped by the group(0)
-of any regex match. Tests with no match are not grouped.
+In certain scenarios you may want to group tests of a certain type together so
+that they will be run by the same worker process. The ``group_regex`` option in
+the stestr config file permits this. When set, tests are grouped by the entire
+matching portion of the regex. The match must begin at the start of the string.
+Tests with no match are not grouped.
 
 For example, setting the following option in the stestr config file will group
 tests in the same class together (the last '.' splits the class and test