]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
rust/docs: fix critical typo for missing_docs lint
authorcypherpunks <cypherpunks@torproject.org>
Fri, 3 Aug 2018 20:06:40 +0000 (20:06 +0000)
committerNick Mathewson <nickm@torproject.org>
Thu, 16 Aug 2018 12:42:57 +0000 (08:42 -0400)
Fix typo from fe66d06a45a4714141eba992fe87ec3dd5fa1c22.
The exclamation point is what lets an attribute apply to
an entire crate, without the ! it's practically a placebo.

Fix on commits af182d4ab51d6a1a70559bbdcd4ab842aa855684 and
b6059297d7cb76f0e00e2098e38d6677d3033340, and note there are
still missing docs in both crypto and protover, for now.

https://doc.rust-lang.org/reference/attributes.html

doc/HACKING/CodingStandardsRust.md
src/rust/crypto/lib.rs
src/rust/protover/lib.rs

index d9496c08f76605f3e61e98438f38d609da9751f9..fc562816db6336754981e3c436498cd962ce0e1f 100644 (file)
@@ -104,7 +104,7 @@ repo.
  Documentation
 ---------------
 
-You MUST include `#[deny(missing_docs)]` in your crate.
+You MUST include `#![deny(missing_docs)]` in your crate.
 
 For function/method comments, you SHOULD include a one-sentence, "first person"
 description of function behaviour (see requirements for documentation as
index f72a859dd78543ef9ef54f0f6cce7f3e327677fd..3b58935fda81fde4f9fae92985d73f8faaff0d91 100644 (file)
@@ -24,7 +24,8 @@
 //! assert!(result == [b'X'; DIGEST256_LEN]);
 //! ```
 
-#[deny(missing_docs)]
+// XXX: add missing docs
+//#![deny(missing_docs)]
 
 // External crates from cargo or TOR_RUST_DEPENDENCIES.
 extern crate digest;
index 5da562c1e0baf4fbdb9bcabf44e7b94bf04b9a0c..4ea20665c8b1b0ebe5212fd1668631035cf81a3d 100644 (file)
@@ -22,7 +22,8 @@
 //! protocols to develop independently, without having to claim compatibility
 //! with specific versions of Tor.
 
-#[deny(missing_docs)]
+// XXX: add missing docs
+//#![deny(missing_docs)]
 
 extern crate libc;
 extern crate smartlist;