improve documentation of Names iterator

frewsxcv · Jul 31, 2023 · 5272d41 · 5272d41
1 parent abe5d70
commit 5272d41
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/names.rs b/src/names.rs
@@ -1,4 +1,7 @@
-/// Iterator over all possible permutations of `-_` in crate names
+/// An iterator over all possible permutations of hyphens (`-`) and underscores (`_`) of a crate name.
+///
+/// For instance, the name `parking_lot` is turned into the sequence `parking_lot` and `parking_lot`, while
+/// `serde-yaml` is turned into `serde-yaml` and `serde_yaml`.
 #[derive(Clone)]
 pub struct Names {
     count: Option<u16>,