Skip to content

Commit 665f864

Browse files
committed
clippy: shorten a doccomment's first line
The original doccomment was a self-contained single-sentence description of this iterator. But it was really long and hard to follow. Better to separate out some details into a separate paragraph.
1 parent 2052ec1 commit 665f864

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/primitives/encode.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,11 @@ where
169169
}
170170
}
171171

172-
/// Iterator adaptor which takes a stream of field elements, converts it to characters prefixed by
173-
/// an HRP (and separator), and suffixed by the checksum i.e., converts the data in a stream of
174-
/// field elements into stream of characters representing the encoded bech32 string.
172+
/// Iterator adaptor which converts a stream of field elements to an iterator over the
173+
/// characters of an HRP-string.
174+
///
175+
/// Does so by converting the field elements to characters, prefixing an HRP, and suffixing
176+
/// a checksum.
175177
pub struct CharIter<'hrp, I, Ck>
176178
where
177179
I: Iterator<Item = Fe32>,

0 commit comments

Comments
 (0)