rust-readme: mentioning clippy
especially since there is a CI check for it.
--- a/rust/README.rst Tue Apr 04 11:44:43 2023 +0200
+++ b/rust/README.rst Tue Apr 04 11:46:26 2023 +0200
@@ -124,3 +124,21 @@
$ cargo +nightly fmt
This requires you to have the nightly toolchain installed.
+
+Linting: code sanity
+--------------------
+
+We're using `Clippy`_, the standard code diagnosis tool of the Rust
+community.
+
+Our CI enforces that the code is free of Clippy warnings, so you might
+want to run it on your side before submitting your changes. Simply do::
+
+ % cargo clippy
+
+from the top of the Rust workspace. Clippy is part of the default
+``rustup`` install, so it should work right away. In case it would
+not, you can install it with ``rustup component add``.
+
+
+.. _Clippy: https://doc.rust-lang.org/stable/clippy/