about summary refs log tree commit diff
path: root/src/docs/cognitive_complexity.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/cognitive_complexity.txt')
-rw-r--r--src/docs/cognitive_complexity.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/docs/cognitive_complexity.txt b/src/docs/cognitive_complexity.txt
new file mode 100644
index 00000000000..fdd75f6479c
--- /dev/null
+++ b/src/docs/cognitive_complexity.txt
@@ -0,0 +1,13 @@
+### What it does
+Checks for methods with high cognitive complexity.
+
+### Why is this bad?
+Methods of high cognitive complexity tend to be hard to
+both read and maintain. Also LLVM will tend to optimize small methods better.
+
+### Known problems
+Sometimes it's hard to find a way to reduce the
+complexity.
+
+### Example
+You'll see it when you get the warning.
\ No newline at end of file