Changes per comments - remove comments from code and clarify/split test file

Author: davidBar-On

src/formatting/visitor.rs

@@ -486,7 +486,6 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
             // For use/extern crate items, skip rewriting attributes but check for a skip attribute.
             ast::ItemKind::Use(..) | ast::ItemKind::ExternCrate(_) => {
                 if contains_skip(attrs) {
-                    // `item.span()` includes the attributes, while `item.span` does not.
                     self.push_skipped_with_span(attrs.as_slice(), item.span(), item.span);
                     false
                 } else {
@@ -496,7 +495,6 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
             // Module is inline, in this case we treat it like any other item.
             _ if !is_mod_decl(item) => {
                 if self.visit_attrs(&item.attrs, ast::AttrStyle::Outer) {
-                    // `item.span()` includes the attributes, while `item.span` does not.
                     self.push_skipped_with_span(item.attrs.as_slice(), item.span(), item.span);
                     false
                 } else {
@@ -517,7 +515,6 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
             }
             _ => {
                 if self.visit_attrs(&item.attrs, ast::AttrStyle::Outer) {
-                    // `item.span()` includes the attributes, while `item.span` does not.
                     self.push_skipped_with_span(item.attrs.as_slice(), item.span(), item.span);
                     false
                 } else {
@@ -675,7 +672,6 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
         skip_out_of_file_lines_range_visitor!(self, ti.span);
 
         if self.visit_attrs(&ti.attrs, ast::AttrStyle::Outer) {
-            // `ti.span()` includes the attributes, while `ti.span` does not.
             self.push_skipped_with_span(ti.attrs.as_slice(), ti.span(), ti.span);
             return;
         }
@@ -736,7 +732,6 @@ impl<'b, 'a: 'b> FmtVisitor<'a> {
         skip_out_of_file_lines_range_visitor!(self, ii.span);
 
         if self.visit_attrs(&ii.attrs, ast::AttrStyle::Outer) {
-            // `ii.span()` includes the attributes, while `ii.span` does not.
             self.push_skipped_with_span(ii.attrs.as_slice(), ii.span(), ii.span);
             return;
         }

tests/source/issue-4499.rs

@@ -0,0 +1,29 @@
+// *** Doc comment which is attribute vs one-line comment
+// *** All source lines starts with indent by 3 tabls.
+			impl Struct {
+			/// Documentation for `foo`
+			#[rustfmt::skip]
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}
+
+			impl Struct {
+			// Comment for `foo`
+			#[rustfmt::skip]
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}
+
+			fn main() {
+			/// Documentation for `foo`
+			#[rustfmt::skip]
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}
+
+			fn main() {
+			// Comment for `foo`
+			#[rustfmt::skip] // comment on why use a skip here
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}

tests/source/skip/issue-4499-skip-and-doc-comment.rs

@@ -0,0 +1,17 @@
+// *** "rustfmt::skip" and Use/Extern
+// *** All source lines starts with indent by 3 tabls.
+			#[rustfmt::skip]
+			use rustc_ast::{ast, attr::HasAttrs, token::DelimToken, visit};
+			use crate::config::{BraceStyle, Config};
+			use crate::formatting::{
+			attr::*,
+			modules::{FileModMap, Module},
+			};
+
+			use rustc_ast::{ast, attr::HasAttrs, token::DelimToken, visit};
+			#[rustfmt::skip]
+			use crate::config::{BraceStyle, Config};
+			use crate::formatting::{
+			attr::*,
+			modules::{FileModMap, Module},
+			};

tests/source/skip/issue-4499-skip-and-imports.rs

@@ -0,0 +1,32 @@
+// *** "rustfmt::skip" and Trait with Attributes
+// *** All source lines starts with indent by 3 tabls.
+            #[rustfmt::skip]
+            #[allow(non_snake_case)]
+            trait Animal1 {
+            // Static method signature; `Self` refers to the implementor type.
+            fn new(name: &'static str) -> Self;
+
+            // Traits can provide default method definitions.
+            fn talk(&self) {
+            println!("{} says {}", self.name(), self.noise());
+            }
+            }
+
+            trait Animal2 {
+            // Static method signature; `Self` refers to the implementor type.
+            fn new(name: &'static str) -> Self;
+
+            // Instance method signatures; these will return a string.
+            fn name(&self) -> &'static str;
+            #[rustfmt::skip]
+            #[allow(non_snake_case)]
+            fn noise(&self) -> &'static str;
+
+            fn talk(&self) {
+            // Traits can provide default method definitions.
+            #[rustfmt::skip]
+            #[allow(non_snake_case)]
+            fn name(&self) -> &'static str;
+            println!("{} says {}", self.name(), self.noise());
+            }
+            }

tests/source/skip/issue-4499-skip-and-trait-with-attrs.rs

@@ -0,0 +1,56 @@
+// *** "rustfmt::skip" as first line
+
+// *** Original code from issue #4499
+#[rustfmt::skip]
+			/** Comment.
+
+    Rustfmt skips this as expected. */
+					fn main() {
+				for _ in 1..Foo::getRandomNumber() {
+        println!("Hello, world!");
+			}
+}
+
+struct Foo;
+				impl Foo {
+            #[rustfmt::skip]
+				/** Comment.
+
+        Rustfmt unindents this despite the ::skip above. */
+			#[allow(non_snake_case)]
+				pub fn getRandomNumber() -> i32 { 4 }
+}
+
+// *** Other test with "rustfmt::skip" as first line;
+// *** All source lines starts with indent by 3 tabls. 
+			#[rustfmt::skip]
+			/** Comment line 1
+			comment line 2. */
+			#[allow(non_snake_case)]
+			impl Foo {
+			pub fn getRandomNumber() -> i32 { 4 }
+			}
+
+			#[rustfmt::skip]
+			/** Comment line 1
+			comment line 2. */
+			fn main() {
+			x = y;
+			}
+
+// *** "rustfmt::skip" as first line inside a module
+			impl Foo {
+			#[rustfmt::skip]
+			/** Comment line 1
+			comment line 2. */
+			#[allow(non_snake_case)]
+			pub fn getRandomNumber() -> i32 { 4 }
+			}
+
+			fn main() {
+			#[rustfmt::skip]
+			/** Comment line 1
+			comment line 2. */
+			#[allow(non_snake_case)]
+			x = y;
+			}

tests/source/skip/issue-4499-skip-as-first-line.rs

@@ -0,0 +1,29 @@
+// *** "rustfmt::skip" whithin a block of attributes
+// *** All source lines starts with indent by 3 tabls.
+			fn main() {
+			#[rustfmt::skip]
+			// Comment 1
+			#[allow(non_snake_case)]
+			// Comment 2
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}
+
+			impl Foo {
+			// Comment 1
+			#[rustfmt::skip]
+			#[allow(non_snake_case)]
+			// Comment 2
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}
+
+			impl Foo {
+			// Comment 1
+			#[allow(non_snake_case)]
+			// Comment 2
+			#[allow(non_snake_case)]
+			#[rustfmt::skip]
+			#[allow(non_snake_case)]
+			pub fn foo(&self) {}
+			}