summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/type_complexity.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/type_complexity.txt')
-rw-r--r--src/tools/clippy/src/docs/type_complexity.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/type_complexity.txt b/src/tools/clippy/src/docs/type_complexity.txt
new file mode 100644
index 000000000..69cd87500
--- /dev/null
+++ b/src/tools/clippy/src/docs/type_complexity.txt
@@ -0,0 +1,14 @@
+### What it does
+Checks for types used in structs, parameters and `let`
+declarations above a certain complexity threshold.
+
+### Why is this bad?
+Too complex types make the code less readable. Consider
+using a `type` definition to simplify them.
+
+### Example
+```
+struct Foo {
+ inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>>,
+}
+``` \ No newline at end of file