regex: correct outdated docs

BurntSushi · BurntSushi · commit 3981d2ad0071 · 2018-07-18T09:09:43.000-04:00
This fixes a bug in the documentation of RegexBuilder that reflected the
old behavior of bytes::Regex where it disabled Unicode mode by default.
Instead, Unicode mode is now enabled by the default, and we can explain
the semantics of `.` purely in terms of whether Unicode mode is enabled
or not.
diff --git a/src/re_builder.rs b/src/re_builder.rs
@@ -106,9 +106,9 @@ impl RegexBuilder {
     /// anything when `s` is set and matches anything except for new line when
     /// it is not set (the default).
     ///
-    /// N.B. "matches anything" means "any byte" for `regex::bytes::Regex`
-    /// expressions and means "any Unicode scalar value" for `regex::Regex`
-    /// expressions.
+    /// N.B. "matches anything" means "any byte" when Unicode is disabled and
+    /// means "any valid UTF-8 encoding of any Unicode scalar value" when
+    /// Unicode is enabled.
     pub fn dot_matches_new_line(&mut self, yes: bool) -> &mut RegexBuilder {
         self.0.dot_matches_new_line = yes;
         self
