Improve the "MATCHING WITH SUBSTRING EXTRACTION" comment.
Change-Id: I0c86627f70fc145a30ae421bfccade2c333464fb
Reviewed-on: https://code-review.googlesource.com/c/35050
Reviewed-by: Paul Wankadia <junyer@google.com>
diff --git a/re2/re2.h b/re2/re2.h
index 4be959f..1b91343 100644
--- a/re2/re2.h
+++ b/re2/re2.h
@@ -53,9 +53,13 @@
// CHECK(RE2::FullMatch(latin1_string, RE2(latin1_pattern, RE2::Latin1)));
//
// -----------------------------------------------------------------------
-// MATCHING WITH SUB-STRING EXTRACTION:
+// MATCHING WITH SUBSTRING EXTRACTION:
//
-// You can supply extra pointer arguments to extract matched subpieces.
+// You can supply extra pointer arguments to extract matched substrings.
+// If the match succeeds, the substrings will be converted (as necessary)
+// and their values will be assigned to their pointees. If the match fails
+// OR any conversion fails, the pointees will be in an indeterminate state.
+// (Note that the interface conflates match failure and conversion failure.)
//
// Example: extracts "ruby" into "s" and 1234 into "i"
// int i;
diff --git a/util/pcre.h b/util/pcre.h
index 7c6403d..10ec4f2 100644
--- a/util/pcre.h
+++ b/util/pcre.h
@@ -61,9 +61,9 @@
// CHECK(PCRE::FullMatch(utf8_string, re));
//
// -----------------------------------------------------------------------
-// MATCHING WITH SUB-STRING EXTRACTION:
+// MATCHING WITH SUBSTRING EXTRACTION:
//
-// You can supply extra pointer arguments to extract matched subpieces.
+// You can supply extra pointer arguments to extract matched substrings.
//
// Example: extracts "ruby" into "s" and 1234 into "i"
// int i;
