From 01e68b4d895e2250c34dda0c76d565e35ead9d5e Mon Sep 17 00:00:00 2001
From: Caemor <11088935+caemor@users.noreply.github.com>
Date: Mon, 28 Oct 2024 14:35:26 +0100
Subject: [PATCH] v0.6 doc fixes

---
 .github/workflows/rust.yml | 2 ++
 src/epd2in9d/mod.rs        | 2 +-
 src/graphics.rs            | 8 ++++----
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
index 55a8c545..0c06d2f5 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@@ -7,6 +7,8 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: -Dwarnings
     strategy:
       matrix:
         rust:
diff --git a/src/epd2in9d/mod.rs b/src/epd2in9d/mod.rs
index 95d72398..4a7e0952 100644
--- a/src/epd2in9d/mod.rs
+++ b/src/epd2in9d/mod.rs
@@ -3,7 +3,7 @@
 //!
 //! 参考[Waveshare](https://www.waveshare.net/wiki/2.9inch_e-Paper_HAT_%28D%29)的文档/例程进行构建
 //!
-//! Specification: https://www.waveshare.net/w/upload/b/b5/2.9inch_e-Paper_%28D%29_Specification.pdf
+//! Specification: <https://www.waveshare.net/w/upload/b/b5/2.9inch_e-Paper_%28D%29_Specification.pdf>
 
 use core::slice::from_raw_parts;
 
diff --git a/src/graphics.rs b/src/graphics.rs
index 51ddda58..4264b981 100644
--- a/src/graphics.rs
+++ b/src/graphics.rs
@@ -24,7 +24,7 @@ const fn line_bytes(width: u32, bits_per_pixel: usize) -> usize {
     (width as usize * bits_per_pixel + 7) / 8
 }
 
-/// Display bffer used for drawing with embedded graphics
+/// Display buffer used for drawing with embedded graphics
 /// This can be rendered on EPD using ...
 ///
 /// - WIDTH: width in pixel when display is not rotated
@@ -32,17 +32,17 @@ const fn line_bytes(width: u32, bits_per_pixel: usize) -> usize {
 /// - BWRBIT: mandatory value of the B/W when chromatic bit is set, can be any value for non
 ///           tricolor epd
 /// - COLOR: color type used by the target display
-/// - BYTECOUNT: This is redundant with prvious data and should be removed when const generic
+/// - BYTECOUNT: This is redundant with previous data and should be removed when const generic
 ///              expressions are stabilized
 ///
 /// More on BWRBIT:
 ///
 /// Different chromatic displays differently treat the bits in chromatic color planes.
 /// Some of them ([crate::epd2in13bc]) will render a color pixel if bit is set for that pixel,
-/// which is a [DisplayColorRendering::Positive] mode.
+/// which is a `BWRBIT = true` mode.
 ///
 /// Other displays, like [crate::epd5in83b_v2] in opposite, will draw color pixel if bit is
-/// cleared for that pixel, which is a [DisplayColorRendering::Negative] mode.
+/// cleared for that pixel, which is a `BWRBIT = false` mode.
 ///
 /// BWRBIT=true: chromatic doesn't override white, white bit cleared for black, white bit set for white, both bits set for chromatic
 /// BWRBIT=false: chromatic does override white, both bits cleared for black, white bit set for white, red bit set for black