nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-12 22:23:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

rust/docs: fix critical typo for missing_docs lint

Browse Source 
Fix typo from fe66d06a45.
The exclamation point is what lets an attribute apply to
an entire crate, without the ! it's practically a placebo.

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

https://doc.rust-lang.org/reference/attributes.html
This commit is contained in:
cypherpunks 2018-08-03 20:06:40 +00:00 committed by Nick Mathewson
parent 8410d3b0ad
commit fef2ba2267
3 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/HACKING/CodingStandardsRust.md
View File

@ -104,7 +104,7 @@ repo.
Documentation 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" For function/method comments, you SHOULD include a one-sentence, "first person"
description of function behaviour (see requirements for documentation as description of function behaviour (see requirements for documentation as

3
src/rust/crypto/lib.rs
View File

@ -24,7 +24,8 @@
//! assert!(result == [b'X'; DIGEST256_LEN]); //! assert!(result == [b'X'; DIGEST256_LEN]);
//! ``` //! ```
#[deny(missing_docs)] // XXX: add missing docs
//#![deny(missing_docs)]
// External crates from cargo or TOR_RUST_DEPENDENCIES. // External crates from cargo or TOR_RUST_DEPENDENCIES.
extern crate digest; extern crate digest;

3
src/rust/protover/lib.rs
View File

@ -22,7 +22,8 @@
//! protocols to develop independently, without having to claim compatibility //! protocols to develop independently, without having to claim compatibility
//! with specific versions of Tor. //! with specific versions of Tor.
#[deny(missing_docs)] // XXX: add missing docs
//#![deny(missing_docs)]
extern crate libc; extern crate libc;
extern crate smartlist; extern crate smartlist;