summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNora Widdecke <nora@sequoia-pgp.org>2021-10-25 18:11:14 +0200
committerNora Widdecke <nora@sequoia-pgp.org>2021-10-28 13:58:41 +0200
commit8785a2b7b154663989ee328096af037d4fb17b3f (patch)
tree68f4c9376d72747b934643c3c8008d3ff70bd704
parentc577c03ed32988893f30169a1e58d662bb504e8f (diff)
net, openpgp: Fix private documentation.
-rw-r--r--net/src/wkd.rs4
-rw-r--r--openpgp/src/armor.rs2
-rw-r--r--openpgp/src/macros.rs2
-rw-r--r--openpgp/src/seal.rs2
4 files changed, 5 insertions, 5 deletions
diff --git a/net/src/wkd.rs b/net/src/wkd.rs
index c5cf4117..f1efff8f 100644
--- a/net/src/wkd.rs
+++ b/net/src/wkd.rs
@@ -179,10 +179,10 @@ impl Url {
/// Returns a 32 characters string from the local part of an email address
///
-/// [draft-koch]:
+/// From [draft-koch]:
/// The so mapped local-part is hashed using the SHA-1 algorithm. The
/// resulting 160 bit digest is encoded using the Z-Base-32 method as
-/// described in [RFC6189], section 5.1.6. The resulting string has a
+/// described in RFC6189, section 5.1.6. The resulting string has a
/// fixed length of 32 octets.
fn encode_local_part<S: AsRef<str>>(local_part: S) -> String {
let local_part = local_part.as_ref();
diff --git a/openpgp/src/armor.rs b/openpgp/src/armor.rs
index 9534cf65..c9c87e95 100644
--- a/openpgp/src/armor.rs
+++ b/openpgp/src/armor.rs
@@ -99,7 +99,7 @@ impl Arbitrary for Kind {
/// This is a non-public variant of `Kind` that is currently only used
/// for detecting the kind on consumption.
///
-/// See also https://gitlab.com/sequoia-pgp/sequoia/-/issues/672
+/// See also <https://gitlab.com/sequoia-pgp/sequoia/-/issues/672>.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Label {
/// A generic OpenPGP message. (Since its structure hasn't been
diff --git a/openpgp/src/macros.rs b/openpgp/src/macros.rs
index 1714fa1b..bdcd591a 100644
--- a/openpgp/src/macros.rs
+++ b/openpgp/src/macros.rs
@@ -142,7 +142,7 @@ macro_rules! time_it {
/// trait bounds:
///
/// ```
-/// pub struct MyWriterWithLifetime<a', C, W: io::Write> {}
+/// pub struct MyWriterWithLifetime<'a, C, W: io::Write> {};
/// assert_send_and_sync!(MyWriterStruct<'_, C, W> where C, W: io::Write);
/// ```
///
diff --git a/openpgp/src/seal.rs b/openpgp/src/seal.rs
index 1f315263..20b8ae1f 100644
--- a/openpgp/src/seal.rs
+++ b/openpgp/src/seal.rs
@@ -1,6 +1,6 @@
//! [Sealing Traits]
//!
-//! [sealing traits:] https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed
+//! [Sealing Traits]: https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed
//!
//! Prevent the implementation of traits outside of the crate
//! to allow extension of the traits at a later time.