summaryrefslogtreecommitdiffstats
path: root/ignore
diff options
context:
space:
mode:
authorGarrett Squire <garrettsquire@gmail.com>2018-05-06 16:03:11 -0700
committerAndrew Gallant <jamslam@gmail.com>2018-05-06 19:03:11 -0400
commit83b4fdb8d664afe7773ce674b5f1b658c2c5a057 (patch)
tree4d08c72d6760fa43a47c19bdd2570bf6515b54f6 /ignore
parent8b57d78b96f9b659595297a19627bd45a6ee4025 (diff)
ignore/doc: improve docs for case_insensitive
This commit updates the OverrideBuilder and GitignoreBuilder docs for the case_insensitive method, denoting that it must be called before adding any patterns.
Diffstat (limited to 'ignore')
-rw-r--r--ignore/src/gitignore.rs2
-rw-r--r--ignore/src/overrides.rs2
2 files changed, 4 insertions, 0 deletions
diff --git a/ignore/src/gitignore.rs b/ignore/src/gitignore.rs
index abcb3685..b6874d98 100644
--- a/ignore/src/gitignore.rs
+++ b/ignore/src/gitignore.rs
@@ -500,6 +500,8 @@ impl GitignoreBuilder {
/// Toggle whether the globs should be matched case insensitively or not.
///
+ /// When this option is changed, only globs added after the change will be affected.
+ ///
/// This is disabled by default.
pub fn case_insensitive(
&mut self, yes: bool
diff --git a/ignore/src/overrides.rs b/ignore/src/overrides.rs
index 955dc5ad..c63532af 100644
--- a/ignore/src/overrides.rs
+++ b/ignore/src/overrides.rs
@@ -140,6 +140,8 @@ impl OverrideBuilder {
/// Toggle whether the globs should be matched case insensitively or not.
///
+ /// When this option is changed, only globs added after the change will be affected.
+ ///
/// This is disabled by default.
pub fn case_insensitive(
&mut self, yes: bool