Skip to content

Commit

Permalink
Add full stops to error rustdocs
Browse files Browse the repository at this point in the history
In preparation for improving the error code make all the rustdocs
complete sentences by adding a full stop.
  • Loading branch information
tcharding committed Aug 14, 2022
1 parent d12513f commit 6052c60
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -659,22 +659,22 @@ const GEN: [u32; 5] = [
0x2a14_62b3,
];

/// Error types for Bech32 encoding / decoding
/// Error types for Bech32 encoding / decoding.
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum Error {
/// String does not contain the separator character
/// String does not contain the separator character.
MissingSeparator,
/// The checksum does not match the rest of the data
/// The checksum does not match the rest of the data.
InvalidChecksum,
/// The data or human-readable part is too long or too short
/// The data or human-readable part is too long or too short.
InvalidLength,
/// Some part of the string contains an invalid character
/// Some part of the string contains an invalid character.
InvalidChar(char),
/// Some part of the data has an invalid value
/// Some part of the data has an invalid value.
InvalidData(u8),
/// The bit conversion failed due to a padding issue
/// The bit conversion failed due to a padding issue.
InvalidPadding,
/// The whole string must be of one case
/// The whole string must be of one case.
MixedCase,
}

Expand Down

0 comments on commit 6052c60

Please sign in to comment.