Note the difference between new() and default()

Signed-off-by: Yuki Okushi <jtitor@2k36.org>
rust-lang · Oct 29, 2022 · 6631fd7 · 6631fd7
1 parent 80588ef
commit 6631fd7
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1004,6 +1004,11 @@ impl MatchOptions {
     ///     require_literal_leading_dot: false
     /// }
     /// ```
+    ///
+    /// # Note
+    /// The behavior of this method doesn't match `default()`'s. This returns
+    /// `case_sensitive` as `true` while `default()` does it as `false`.
+    // FIXME: Consider unity the behavior with `default()` in a next major release.
     pub fn new() -> Self {
         Self {
             case_sensitive: true,