readme and some comments

NULLx76 · Jun 10, 2023 · db03cf8 · db03cf8 · github-actions · Jun 10, 2023
1 parent 72ccd2a
commit db03cf8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -88,9 +88,9 @@ compared here can grow unbounded (though in benchmarks they weren't filled over
 
 # Features
 
-| name  | default | description                                                                                                  |
-|-------|---------|--------------------------------------------------------------------------------------------------------------|
-| alloc | ✓       | Disable this feature to remove the dependency on alloc. Disabling this feature  makes `ringbuffer` `no_std`. |
+| name  | default | description                                                                                                |
+|-------|---------|------------------------------------------------------------------------------------------------------------|
+| alloc | ✓       | Disable this feature to remove the dependency on alloc.                                                    |
 
 # License
 

diff --git a/src/with_alloc/alloc_ringbuffer.rs b/src/with_alloc/alloc_ringbuffer.rs
@@ -324,6 +324,7 @@ unsafe impl<T, SIZE: RingbufferSize> RingBuffer<T> for AllocRingBuffer<T, SIZE>
 
     #[inline]
     fn fill_with<F: FnMut() -> T>(&mut self, mut f: F) {
+        // This clear is necessary so that the drop methods are called.
         self.clear();
 
         self.readptr = 0;