about summary refs log tree commit diff
path: root/src/docs/disallowed_methods.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/disallowed_methods.txt')
-rw-r--r--src/docs/disallowed_methods.txt41
1 files changed, 0 insertions, 41 deletions
diff --git a/src/docs/disallowed_methods.txt b/src/docs/disallowed_methods.txt
deleted file mode 100644
index d8ad5b6a667..00000000000
--- a/src/docs/disallowed_methods.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-### What it does
-Denies the configured methods and functions in clippy.toml
-
-Note: Even though this lint is warn-by-default, it will only trigger if
-methods are defined in the clippy.toml file.
-
-### Why is this bad?
-Some methods are undesirable in certain contexts, and it's beneficial to
-lint for them as needed.
-
-### Example
-An example clippy.toml configuration:
-```
-disallowed-methods = [
-    # Can use a string as the path of the disallowed method.
-    "std::boxed::Box::new",
-    # Can also use an inline table with a `path` key.
-    { path = "std::time::Instant::now" },
-    # When using an inline table, can add a `reason` for why the method
-    # is disallowed.
-    { path = "std::vec::Vec::leak", reason = "no leaking memory" },
-]
-```
-
-```
-// Example code where clippy issues a warning
-let xs = vec![1, 2, 3, 4];
-xs.leak(); // Vec::leak is disallowed in the config.
-// The diagnostic contains the message "no leaking memory".
-
-let _now = Instant::now(); // Instant::now is disallowed in the config.
-
-let _box = Box::new(3); // Box::new is disallowed in the config.
-```
-
-Use instead:
-```
-// Example code which does not raise clippy warning
-let mut xs = Vec::new(); // Vec::new is _not_ disallowed in the config.
-xs.push(123); // Vec::push is _not_ disallowed in the config.
-```
\ No newline at end of file