update docs

libc-test/test/check_style.rs

@@ -8,19 +8,6 @@
 //! ```notrust
 //! cargo test --test style
 //! ```
-//!
-//! ## Guidelines
-//!
-//! The current style is:
-//!
-//! * Specific module layout:
-//!     1. use directives
-//!     2. typedefs
-//!     3. structs
-//!     4. constants
-//!     5. f! { ... } functions
-//!     6. extern functions
-//!     7. modules + pub use
 
 pub mod style;
 

libc-test/test/style/mod.rs

@@ -2,7 +2,24 @@
 //! this library.
 //!
 //! This is split out so that the implementation itself can be tested
-//! separately, see test/check_style.rs for how it's used.
+//! separately, see test/check_style.rs for how it's used and
+//! test/style_tests.rs for the implementation tests.
+//!
+//! ## Guidelines
+//!
+//! The current style is:
+//!
+//! * Specific module layout:
+//!     1. use directives
+//!     2. typedefs
+//!     3. structs
+//!     4. constants
+//!     5. f! { ... } functions
+//!     6. extern functions
+//!     7. modules + pub use
+//! * Use cfg_if! over #[cfg(...)]
+//! * No manual deriving Copy/Clone
+//! * Only one f! per module
 
 use std::fs;
 use std::ops::Deref;
@@ -20,16 +37,21 @@ pub type Result<T> = std::result::Result<T, Error>;
 
 #[derive(Default)]
 pub struct StyleChecker {
+    /// The state the style checker is in, used to enforce the module layout.
     state: State,
-    /// Span of the first item encountered in this state
-    /// to use in help diagnostic text.
+    /// Span of the first item encountered in this state to use in help
+    /// diagnostic text.
     state_span: Option<Span>,
     // FIXME: see StyleChecker::set_state
     _s_macros: usize,
+    /// Span of the first f! macro seen, used to enforce only one f! macro
+    /// per module.
     first_f_macro: Option<Span>,
+    /// The errors that the style checker has seen.
     errors: Vec<FileError>,
-    /// Path of the currently active file
+    /// Path of the currently active file.
     path: PathBuf,
+    /// Whether the style checker is currently in an `impl` block.
     in_impl: bool,
 }
 
@@ -204,7 +226,7 @@ impl<'ast> Visit<'ast> for StyleChecker {
             && !(meta_str.contains("target_endian") || meta_str.contains("target_arch"))
         {
             self.error(
-                "#[cfg] over cfg_if!".to_string(),
+                "cfg_if! over #[cfg]".to_string(),
                 span,
                 String::new(),
                 (