appender: cleanup comments

Author: cfilipescu

tracing-appender/src/rolling.rs

@@ -382,8 +382,9 @@ pub fn daily(
 /// The appender returned by `rolling::size` can be used with `non_blocking` to create
 /// a non-blocking, size based rotating appender.
 ///
-/// The location of the log file will be specified the `directory` passed in.
-/// `file_name` specifies the complete name of the log file (no date or time is appended).
+/// The location of the log file will be specified by the `directory` passed in.
+/// `file_name` specifies the complete name of the log file.
+/// `RollingFileAppender` automatically appends the current date in UTC.
 ///
 /// # Examples
 ///

tracing-appender/src/rolling/builder.rs

@@ -237,15 +237,17 @@ impl Builder {
         }
     }
 
-    /// Limits the file size to `n` bytes on disk.
+    /// Limits the file size to `n` bytes on disk, when using SIZE rotation.
     ///
     /// # Examples
     ///
     /// ```
     /// use tracing_appender::rolling::RollingFileAppender;
+    /// use tracing_appender::rolling::Rotation;
     ///
     /// # fn docs() {
     /// let appender = RollingFileAppender::builder()
+    ///     .rotation(Rotation::SIZE) // rotate log files when they reach a certain size
     ///     .max_file_size(1024) // only the most recent 5 log files will be kept
     ///     // ...
     ///     .build("/var/log")