diff --git a/src/names.rs b/src/names.rs index 0ef1075f..ba19aa52 100644 --- 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,