Add formatter to documentation

YushiOMOTE · Jul 13, 2024 · e949ed2 · e949ed2
1 parent b7a07d5
commit e949ed2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ fn main() {
     com_logger::builder()
         .base(0x2f8)                  // Use COM2 port
         .filter(LevelFilter::Debug)   // Print debug log
+        .formatter(|buf, record| writeln!(buf, "{}", record.args())) // Define own format
         .setup();
 
     debug!("Hello");

diff --git a/src/logger.rs b/src/logger.rs
@@ -129,6 +129,7 @@ impl Builder {
 ///    com_logger::builder()
 ///        .base(0x2f8)                  // Use COM2 port
 ///        .filter(LevelFilter::Debug)   // Print debug log
+///        .formatter(|buf, record| writeln!(buf, "{}", record.args())) // Define own format
 ///        .setup();
 ///
 ///    debug!("Hello");

diff --git a/src/serial.rs b/src/serial.rs
@@ -5,6 +5,7 @@ use uart_16550::SerialPort;
 ///
 /// ```rust,no_run
 /// use com_logger::Serial;
+/// use core::fmt::Write;
 ///
 /// fn main() {
 ///    // Setup COM1 serial port.
@@ -15,7 +16,7 @@ use uart_16550::SerialPort;
 ///    s.write(b'P');
 ///
 ///    // Write the string to the serial port.
-///    core::fmt::write(&mut s, format_args!("Hello {}", 0xdead));
+///    writeln!(&mut s, "Hello {}", 0xdead);
 /// }
 /// ```
 pub struct Serial(SerialPort);