Skip to content

Commit c58881e

Browse files
DirbaioDirbaio
authored
Merge pull request #414 from newAM/rustfmt-doc-comments
rustfmt: run on doc comments
2 parents fa67f35 + 5ee530c commit c58881e

12 files changed

+73
-47
lines changed

‎.github/workflows/build.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
uses: actions/checkout@v4
9595

9696
- name: Install Rust
97-
uses: dtolnay/rust-toolchain@stable
97+
uses: dtolnay/rust-toolchain@nightly
9898
with:
9999
components: rustfmt
100100

‎rustfmt.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
format_code_in_doc_comments = true

‎src/binary_heap.rs

-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,6 @@ where
203203
/// // Print 1, 2, 3, 4 in arbitrary order
204204
/// for x in heap.iter() {
205205
/// println!("{}", x);
206-
///
207206
/// }
208207
/// ```
209208
pub fn iter(&self) -> slice::Iter<'_, T> {

‎src/defmt.rs

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
//! Defmt implementations for heapless types
2-
//!
32
43
use crate::Vec;
54
use defmt::Formatter;

‎src/deque.rs

-1
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,6 @@ impl<T: fmt::Debug, const N: usize> fmt::Debug for Deque<T, N> {
385385
/// An iterator that moves out of a [`Deque`].
386386
///
387387
/// This struct is created by calling the `into_iter` method.
388-
///
389388
#[derive(Clone)]
390389
pub struct IntoIter<T, const N: usize> {
391390
deque: Deque<T, N>,

‎src/histbuf.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ use core::slice;
2828
/// assert_eq!(buf.recent(), Some(&4));
2929
///
3030
/// // To access all elements in an unspecified order, use `as_slice()`.
31-
/// for el in buf.as_slice() { println!("{:?}", el); }
31+
/// for el in buf.as_slice() {
32+
/// println!("{:?}", el);
33+
/// }
3234
///
3335
/// // Now we can prepare an average of all values, which comes out to 4.
3436
/// let avg = buf.as_slice().iter().sum::<usize>() / buf.len();
@@ -232,7 +234,6 @@ impl<T, const N: usize> HistoryBuffer<T, N> {
232234
/// for (x, y) in buffer.oldest_ordered().zip(expected.iter()) {
233235
/// assert_eq!(x, y)
234236
/// }
235-
///
236237
/// ```
237238
pub fn oldest_ordered(&self) -> OldestOrdered<'_, T, N> {
238239
if self.filled {

‎src/indexmap.rs

+35-15
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,25 @@ use crate::Vec;
2525
/// let mut book_reviews = FnvIndexMap::<_, _, 16>::new();
2626
///
2727
/// // review some books.
28-
/// book_reviews.insert("Adventures of Huckleberry Finn", "My favorite book.").unwrap();
29-
/// book_reviews.insert("Grimms' Fairy Tales", "Masterpiece.").unwrap();
30-
/// book_reviews.insert("Pride and Prejudice", "Very enjoyable.").unwrap();
31-
/// book_reviews.insert("The Adventures of Sherlock Holmes", "Eye lyked it alot.").unwrap();
28+
/// book_reviews
29+
/// .insert("Adventures of Huckleberry Finn", "My favorite book.")
30+
/// .unwrap();
31+
/// book_reviews
32+
/// .insert("Grimms' Fairy Tales", "Masterpiece.")
33+
/// .unwrap();
34+
/// book_reviews
35+
/// .insert("Pride and Prejudice", "Very enjoyable.")
36+
/// .unwrap();
37+
/// book_reviews
38+
/// .insert("The Adventures of Sherlock Holmes", "Eye lyked it alot.")
39+
/// .unwrap();
3240
///
3341
/// // check for a specific one.
3442
/// if !book_reviews.contains_key("Les Misérables") {
35-
/// println!("We've got {} reviews, but Les Misérables ain't one.",
36-
/// book_reviews.len());
43+
/// println!(
44+
/// "We've got {} reviews, but Les Misérables ain't one.",
45+
/// book_reviews.len()
46+
/// );
3747
/// }
3848
///
3949
/// // oops, this review has a lot of spelling mistakes, let's delete it.
@@ -44,7 +54,7 @@ use crate::Vec;
4454
/// for book in &to_find {
4555
/// match book_reviews.get(book) {
4656
/// Some(review) => println!("{}: {}", book, review),
47-
/// None => println!("{} is unreviewed.", book)
57+
/// None => println!("{} is unreviewed.", book),
4858
/// }
4959
/// }
5060
///
@@ -498,15 +508,25 @@ where
498508
/// let mut book_reviews = FnvIndexMap::<_, _, 16>::new();
499509
///
500510
/// // review some books.
501-
/// book_reviews.insert("Adventures of Huckleberry Finn", "My favorite book.").unwrap();
502-
/// book_reviews.insert("Grimms' Fairy Tales", "Masterpiece.").unwrap();
503-
/// book_reviews.insert("Pride and Prejudice", "Very enjoyable.").unwrap();
504-
/// book_reviews.insert("The Adventures of Sherlock Holmes", "Eye lyked it alot.").unwrap();
511+
/// book_reviews
512+
/// .insert("Adventures of Huckleberry Finn", "My favorite book.")
513+
/// .unwrap();
514+
/// book_reviews
515+
/// .insert("Grimms' Fairy Tales", "Masterpiece.")
516+
/// .unwrap();
517+
/// book_reviews
518+
/// .insert("Pride and Prejudice", "Very enjoyable.")
519+
/// .unwrap();
520+
/// book_reviews
521+
/// .insert("The Adventures of Sherlock Holmes", "Eye lyked it alot.")
522+
/// .unwrap();
505523
///
506524
/// // check for a specific one.
507525
/// if !book_reviews.contains_key("Les Misérables") {
508-
/// println!("We've got {} reviews, but Les Misérables ain't one.",
509-
/// book_reviews.len());
526+
/// println!(
527+
/// "We've got {} reviews, but Les Misérables ain't one.",
528+
/// book_reviews.len()
529+
/// );
510530
/// }
511531
///
512532
/// // oops, this review has a lot of spelling mistakes, let's delete it.
@@ -517,7 +537,7 @@ where
517537
/// for book in &to_find {
518538
/// match book_reviews.get(book) {
519539
/// Some(review) => println!("{}: {}", book, review),
520-
/// None => println!("{} is unreviewed.", book)
540+
/// None => println!("{} is unreviewed.", book),
521541
/// }
522542
/// }
523543
///
@@ -759,8 +779,8 @@ where
759779
/* Public API */
760780
/// Returns an entry for the corresponding key
761781
/// ```
762-
/// use heapless::FnvIndexMap;
763782
/// use heapless::Entry;
783+
/// use heapless::FnvIndexMap;
764784
/// let mut map = FnvIndexMap::<_, _, 16>::new();
765785
/// if let Entry::Vacant(v) = map.entry("a") {
766786
/// v.insert(1).unwrap();

‎src/indexset.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ use hash32::{BuildHasherDefault, FnvHasher};
2727
///
2828
/// // Check for a specific one.
2929
/// if !books.contains("The Winds of Winter") {
30-
/// println!("We have {} books, but The Winds of Winter ain't one.",
31-
/// books.len());
30+
/// println!(
31+
/// "We have {} books, but The Winds of Winter ain't one.",
32+
/// books.len()
33+
/// );
3234
/// }
3335
///
3436
/// // Remove a book.
@@ -67,8 +69,10 @@ pub type FnvIndexSet<T, const N: usize> = IndexSet<T, BuildHasherDefault<FnvHash
6769
///
6870
/// // Check for a specific one.
6971
/// if !books.contains("The Winds of Winter") {
70-
/// println!("We have {} books, but The Winds of Winter ain't one.",
71-
/// books.len());
72+
/// println!(
73+
/// "We have {} books, but The Winds of Winter ain't one.",
74+
/// books.len()
75+
/// );
7276
/// }
7377
///
7478
/// // Remove a book.

‎src/lib.rs

-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
//! structure.
4343
//!
4444
//! List of currently implemented data structures:
45-
//!
4645
#![cfg_attr(
4746
any(arm_llsc, target_arch = "x86"),
4847
doc = "- [`Arc`](pool::arc::Arc) -- like `std::sync::Arc` but backed by a lock-free memory pool rather than `#[global_allocator]`"

‎src/sorted_linked_list.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//! # Examples
77
//!
88
//! ```
9-
//! use heapless::sorted_linked_list::{SortedLinkedList, Max};
9+
//! use heapless::sorted_linked_list::{Max, SortedLinkedList};
1010
//! let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
1111
//!
1212
//! // The largest value will always be first
@@ -292,7 +292,7 @@ where
292292
/// # Example
293293
///
294294
/// ```
295-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
295+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
296296
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
297297
///
298298
/// // The largest value will always be first
@@ -322,7 +322,7 @@ where
322322
/// # Example
323323
///
324324
/// ```
325-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
325+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
326326
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
327327
///
328328
/// ll.push(1).unwrap();
@@ -346,7 +346,7 @@ where
346346
/// # Example
347347
///
348348
/// ```
349-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
349+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
350350
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
351351
///
352352
/// ll.push(1).unwrap();
@@ -404,7 +404,7 @@ where
404404
/// # Example
405405
///
406406
/// ```
407-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max, Min};
407+
/// use heapless::sorted_linked_list::{Max, Min, SortedLinkedList};
408408
/// let mut ll_max: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
409409
///
410410
/// // The largest value will always be first
@@ -453,7 +453,7 @@ where
453453
/// # Example
454454
///
455455
/// ```
456-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
456+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
457457
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
458458
///
459459
/// ll.push(1).unwrap();
@@ -477,7 +477,7 @@ where
477477
/// # Example
478478
///
479479
/// ```
480-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
480+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
481481
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
482482
///
483483
/// assert_eq!(ll.is_full(), false);
@@ -499,7 +499,7 @@ where
499499
/// # Example
500500
///
501501
/// ```
502-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
502+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
503503
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
504504
///
505505
/// assert_eq!(ll.is_empty(), true);
@@ -589,7 +589,7 @@ where
589589
/// # Example
590590
///
591591
/// ```
592-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
592+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
593593
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
594594
///
595595
/// ll.push(1).unwrap();
@@ -619,7 +619,7 @@ where
619619
/// # Example
620620
///
621621
/// ```
622-
/// use heapless::sorted_linked_list::{SortedLinkedList, Max};
622+
/// use heapless::sorted_linked_list::{Max, SortedLinkedList};
623623
/// let mut ll: SortedLinkedList<_, _, Max, 3> = SortedLinkedList::new_usize();
624624
///
625625
/// ll.push(1).unwrap();

‎src/spsc.rs

+7-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@
3737
//! ```
3838
//! use heapless::spsc::{Producer, Queue};
3939
//!
40-
//! enum Event { A, B }
40+
//! enum Event {
41+
//! A,
42+
//! B,
43+
//! }
4144
//!
4245
//! fn main() {
4346
//! let queue: &'static mut Queue<Event, 4> = {
@@ -52,9 +55,9 @@
5255
//!
5356
//! loop {
5457
//! match consumer.dequeue() {
55-
//! Some(Event::A) => { /* .. */ },
56-
//! Some(Event::B) => { /* .. */ },
57-
//! None => { /* sleep */ },
58+
//! Some(Event::A) => { /* .. */ }
59+
//! Some(Event::B) => { /* .. */ }
60+
//! None => { /* sleep */ }
5861
//! }
5962
//! # break
6063
//! }

‎src/vec.rs

+8-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ use core::{cmp::Ordering, fmt, hash, iter::FromIterator, mem::MaybeUninit, ops,
77
/// ```
88
/// use heapless::Vec;
99
///
10-
///
1110
/// // A vector with a fixed capacity of 8 elements allocated on the stack
1211
/// let mut vec = Vec::<_, 8>::new();
1312
/// vec.push(1);
@@ -419,7 +418,7 @@ impl<T, const N: usize> Vec<T, N> {
419418
/// Vec::from_iter([0, 0, 1].iter().cloned()),
420419
/// ]
421420
/// .iter()
422-
/// .cloned()
421+
/// .cloned(),
423422
/// );
424423
/// // SAFETY:
425424
/// // 1. `old_len..0` is empty so no elements need to be initialized.
@@ -712,11 +711,13 @@ impl<T, const N: usize> Vec<T, N> {
712711
/// use heapless::Vec;
713712
///
714713
/// let mut vec: Vec<_, 8> = Vec::from_slice(&[1, 2, 3, 4]).unwrap();
715-
/// vec.retain_mut(|x| if *x <= 3 {
716-
/// *x += 1;
717-
/// true
718-
/// } else {
719-
/// false
714+
/// vec.retain_mut(|x| {
715+
/// if *x <= 3 {
716+
/// *x += 1;
717+
/// true
718+
/// } else {
719+
/// false
720+
/// }
720721
/// });
721722
/// assert_eq!(vec, [2, 3, 4]);
722723
/// ```

0 commit comments

Comments
 (0)