Add comment

Lucretiel · Lucretiel · commit f7650fe3f955 · 2020-06-02T01:07:34.000-04:00
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs
@@ -1358,6 +1358,9 @@ mod tests {
         lengths: Vec<usize>,
     }
 
+    // FIXME: rustfmt and tidy disagree about the correct formatting of this
+    // function. This leads to issues for users with editors configured to
+    // rustfmt-on-save.
     impl Read for ShortReader {
         fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
             if self.lengths.is_empty() {

Original file line number	Diff line number	Diff line change
`@@ -1358,6 +1358,9 @@ mod tests {`
`1358`	`1358`	`lengths: Vec<usize>,`
`1359`	`1359`	`}`
`1360`	`1360`
	`1361`	`+ // FIXME: rustfmt and tidy disagree about the correct formatting of this`
	`1362`	`+ // function. This leads to issues for users with editors configured to`
	`1363`	`+ // rustfmt-on-save.`
`1361`	`1364`	`impl Read for ShortReader {`
`1362`	`1365`	`fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {`
`1363`	`1366`	`if self.lengths.is_empty() {`