Cleanup comment out code

.codecov.yml

@@ -5,9 +5,10 @@ ignore:
   - "**/integration/"
   - "**/examples/"
   - "**/benches/"
+  - "src/tests.rs"
+  - "src/error.rs"
   - "src/swmr/generic/traits/impls/"
   - "src/swmr/generic/traits/impls.rs"
-  - "src/tests.rs"
   - "src/swmr/generic/tests.rs"
   - "src/swmr/generic/tests/"
   - "src/swmr/wal/tests.rs"

src/swmr.rs

@@ -1,4 +1,5 @@
-mod wal;
+/// The ordered write-ahead log only supports bytes.
+pub mod wal;
 pub use wal::OrderWal;
 
 /// The generic implementation of the ordered write-ahead log.

src/swmr/generic.rs

@@ -1498,7 +1498,6 @@ where
             requested,
             available,
           } => error::Error::insufficient_space(requested, available),
-          ArenaError::ReadOnly => error::Error::read_only(),
           _ => unreachable!(),
         };
         Err(Among::Right(e))

src/swmr/generic/traits/impls/bytes.rs

@@ -78,7 +78,7 @@ impl<'a> TypeRef<'a> for &'a [u8] {
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct SliceRef<'a>(&'a [u8]);
 
-impl<'a> Borrow<[u8]> for SliceRef<'a> {
+impl Borrow<[u8]> for SliceRef<'_> {
   fn borrow(&self) -> &[u8] {
     self.0
   }

src/swmr/wal.rs

@@ -30,6 +30,7 @@ pub use iter::*;
 ))]
 mod tests;
 
+#[doc(hidden)]
 pub struct OrderWalCore<C, S> {
   arena: Arena,
   map: SkipSet<Pointer<C>>,
@@ -146,7 +147,6 @@ where
             requested,
             available,
           } => error::Error::insufficient_space(requested, available),
-          ArenaError::ReadOnly => error::Error::read_only(),
           _ => unreachable!(),
         };
         Err(Among::Right(e))
@@ -213,13 +213,18 @@ where
 }
 
 impl<C, S> OrderWal<C, S> {
-  // /// Returns the read-only view for the WAL.
-  // #[inline]
-  // pub fn reader(&self) -> OrderWalReader<C, S> {
-  //   OrderWalReader::new(self.core.clone())
-  // }
-
   /// Returns the path of the WAL if it is backed by a file.
+  ///
+  /// # Example
+  ///
+  /// ```rust
+  /// use orderwal::{swmr::OrderWal, Wal, Builder};
+  ///
+  /// // A in-memory WAL
+  /// let wal = OrderWal::new(Builder::new().with_capacity(100)).unwrap();
+  ///
+  /// assert!(wal.path_buf().is_none());
+  /// ```
   pub fn path_buf(&self) -> Option<&std::sync::Arc<std::path::PathBuf>> {
     self.core.arena.path()
   }

src/unsync.rs

@@ -74,6 +74,17 @@ where
 
 impl<C, S> OrderWal<C, S> {
   /// Returns the path of the WAL if it is backed by a file.
+  ///
+  /// # Example
+  ///
+  /// ```rust
+  /// use orderwal::{unsync::OrderWal, Wal, Builder};
+  ///
+  /// // A in-memory WAL
+  /// let wal = OrderWal::new(Builder::new().with_capacity(100)).unwrap();
+  ///
+  /// assert!(wal.path_buf().is_none());
+  /// ```
   pub fn path_buf(&self) -> Option<&std::rc::Rc<std::path::PathBuf>> {
     self.core().arena.path()
   }
@@ -117,7 +128,6 @@ where
             requested,
             available,
           } => error::Error::insufficient_space(requested, available),
-          ArenaError::ReadOnly => error::Error::read_only(),
           _ => unreachable!(),
         };
         Err(Among::Right(e))