Skip to content

Commit 585311b

Browse files
committed
Improve doc-strings for CRC type
1 parent bc22046 commit 585311b

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/crc.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ use std::io;
44
use std::io::prelude::*;
55

66
/// The CRC calculated by a [`CrcReader`].
7-
///
8-
/// [`CrcReader`]: struct.CrcReader.html
97
#[derive(Debug, Default)]
108
pub struct Crc {
119
inner: inner::Crc,
@@ -33,7 +31,9 @@ impl Crc {
3331
self.inner.update(data);
3432
}
3533

36-
/// Reset the CRC.
34+
/// Reset the CRC, to start a new hash.
35+
///
36+
/// Do this in favor of creating a new `Crc` instance.
3737
pub fn reset(&mut self) {
3838
self.inner.reset();
3939
}

0 commit comments

Comments
 (0)