summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/serde_api_misuse.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/serde_api_misuse.txt')
-rw-r--r--src/tools/clippy/src/docs/serde_api_misuse.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/serde_api_misuse.txt b/src/tools/clippy/src/docs/serde_api_misuse.txt
new file mode 100644
index 000000000..8a3c89ac1
--- /dev/null
+++ b/src/tools/clippy/src/docs/serde_api_misuse.txt
@@ -0,0 +1,10 @@
+### What it does
+Checks for mis-uses of the serde API.
+
+### Why is this bad?
+Serde is very finnicky about how its API should be
+used, but the type system can't be used to enforce it (yet?).
+
+### Example
+Implementing `Visitor::visit_string` but not
+`Visitor::visit_str`. \ No newline at end of file