Skip to content

Commit db157f9

Browse files
committed
Improve rustdoc
Make all the docs about deviations from standard uniform.
1 parent e4f16cf commit db157f9

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

src/lib.rs

+3-6
Original file line numberDiff line numberDiff line change
@@ -434,9 +434,8 @@ pub fn encode_to_fmt_anycase<T: AsRef<[u5]>>(
434434
///
435435
/// This method is intended for implementing traits from [`std::fmt`].
436436
///
437-
/// # Errors
437+
/// # Deviations from standard.
438438
///
439-
/// * Deviations from standard.
440439
/// * No length limits are enforced for the data part.
441440
pub fn encode_without_checksum_to_fmt<T: AsRef<[u5]>>(
442441
fmt: &mut dyn fmt::Write,
@@ -484,9 +483,8 @@ impl Variant {
484483

485484
/// Encodes a bech32 payload to string.
486485
///
487-
/// # Errors
486+
/// # Deviations from standard.
488487
///
489-
/// * Deviations from standard.
490488
/// * No length limits are enforced for the data part.
491489
#[cfg(feature = "alloc")]
492490
pub fn encode<T: AsRef<[u5]>>(hrp: Hrp, data: T, variant: Variant) -> Result<String, Error> {
@@ -497,9 +495,8 @@ pub fn encode<T: AsRef<[u5]>>(hrp: Hrp, data: T, variant: Variant) -> Result<Str
497495

498496
/// Encodes a bech32 payload to string without the checksum.
499497
///
500-
/// # Errors
498+
/// # Deviations from standard.
501499
///
502-
/// * Deviations from standard.
503500
/// * No length limits are enforced for the data part.
504501
#[cfg(feature = "alloc")]
505502
pub fn encode_without_checksum<T: AsRef<[u5]>>(hrp: Hrp, data: T) -> Result<String, Error> {

0 commit comments

Comments
 (0)