openpgp: Improve summary line of modules and types.

  - Avoid repeating the type name.

  - Avoid self referential, trivial descriptions.

  - Avoid the terms OpenPGP and Sequoia.

  - Fix mistakes from the Message -> PacketPile rework.

11 files changed, 17 insertions, 17 deletions

diff --git a/openpgp/src/cert/mod.rs b/openpgp/src/cert/mod.rs
index 7f507eb2..ae3d063d 100644
--- a/openpgp/src/cert/mod.rs
+++ b/openpgp/src/cert/mod.rs
@@ -1,4 +1,4 @@
-//! OpenPGP Certificates.
+//! Certificates and related data structures.
 
 use std::io;
 use std::cmp;
@@ -288,7 +288,7 @@ pub trait Preferences<'a, C: 'a>: ValidAmalgamation<'a, C> {
 pub use def::Cert;
 mod def {
 use super::*;
-/// A OpenPGP Certificate.
+/// A collection of keys, signatures, and metadata.
 ///
 /// A Certificate (see [RFC 4880, section 11.1]) can be used to verify
 /// signatures and encrypt data.  It can be stored in a keystore and
diff --git a/openpgp/src/fingerprint.rs b/openpgp/src/fingerprint.rs
index ca015155..117e362b 100644
--- a/openpgp/src/fingerprint.rs
+++ b/openpgp/src/fingerprint.rs
@@ -2,7 +2,7 @@ use std::fmt;
 
 use crate::Result;
 
-/// Holds a fingerprint.
+/// A long identifier for certificates and keys.
 ///
 /// A fingerprint uniquely identifies a public key.  For more details
 /// about how a fingerprint is generated, see [Section 12.2 of RFC
diff --git a/openpgp/src/keyhandle.rs b/openpgp/src/keyhandle.rs
index 8c08c117..f406101d 100644
--- a/openpgp/src/keyhandle.rs
+++ b/openpgp/src/keyhandle.rs
@@ -10,9 +10,9 @@ use crate::{
     Result,
 };
 
-/// Identifies OpenPGP keys.
+/// Identifies certificates and keys.
 ///
-/// An `KeyHandle` is either a `Fingerprint` or a `KeyID`.
+/// A `KeyHandle` is either a `Fingerprint` or a `KeyID`.
 #[derive(Debug, Clone, Hash)]
 pub enum KeyHandle {
     /// A Fingerprint.
diff --git a/openpgp/src/keyid.rs b/openpgp/src/keyid.rs
index 306e9648..2ca86593 100644
--- a/openpgp/src/keyid.rs
+++ b/openpgp/src/keyid.rs
@@ -5,7 +5,7 @@ use crate::Error;
 use crate::Fingerprint;
 use crate::Result;
 
-/// Holds a KeyID.
+/// A short identifier for certificates and keys.
 ///
 /// A KeyID is a fingerprint fragment.  It identifies a public key,
 /// but is easy to forge.  For more details about how a KeyID is
diff --git a/openpgp/src/lib.rs b/openpgp/src/lib.rs
index fab9fd14..4b1f0183 100644
--- a/openpgp/src/lib.rs
+++ b/openpgp/src/lib.rs
@@ -191,7 +191,7 @@ fn frozen_time() -> std::time::SystemTime {
 pub type Result<T> = ::std::result::Result<T, anyhow::Error>;
 
 #[derive(thiserror::Error, Debug, Clone)]
-/// Errors returned by this module.
+/// Errors used in this crate.
 ///
 /// Note: This enum cannot be exhaustively matched to allow future
 /// extensions.
diff --git a/openpgp/src/message/mod.rs b/openpgp/src/message/mod.rs
index 5bb3f2e3..fa99414f 100644
--- a/openpgp/src/message/mod.rs
+++ b/openpgp/src/message/mod.rs
@@ -1,4 +1,4 @@
-//! OpenPGP Message support.
+//! Message support.
 //!
 //! An OpenPGP message is a sequence of OpenPGP packets that
 //! corresponds to an optionally signed, optionally encrypted,
@@ -311,7 +311,7 @@ impl MessageValidator {
 pub use def::Message;
 mod def {
 use super::*;
-/// An OpenPGP message.
+/// A message.
 ///
 /// An OpenPGP message is a structured sequence of OpenPGP packets.
 /// Basically, it's an optionally encrypted, optionally signed literal
diff --git a/openpgp/src/packet/mod.rs b/openpgp/src/packet/mod.rs
index 8db6c30b..2333e393 100644
--- a/openpgp/src/packet/mod.rs
+++ b/openpgp/src/packet/mod.rs
@@ -54,7 +54,7 @@ pub mod aed;
 pub use def::Packet;
 mod def {
 use super::*;
-/// The OpenPGP packets that Sequoia understands.
+/// Enumeration of packet types.
 ///
 /// The different OpenPGP packets are detailed in [Section 5 of RFC 4880].
 ///
diff --git a/openpgp/src/packet_pile.rs b/openpgp/src/packet_pile.rs
index c339095e..19cd892b 100644
--- a/openpgp/src/packet_pile.rs
+++ b/openpgp/src/packet_pile.rs
@@ -15,11 +15,11 @@ use crate::parse::PacketParserBuilder;
 use crate::parse::Parse;
 use crate::parse::Cookie;
 
-/// A `PacketPile` holds a deserialized sequence of OpenPGP messages.
+/// An unstructured packet sequence.
 ///
-/// To deserialize an OpenPGP usage, use either [`PacketParser`],
-/// [`PacketPileParser`], or [`PacketPile::from_file`] (or related
-/// routines).
+/// To deserialize an OpenPGP packet stream, use either
+/// [`PacketParser`], [`PacketPileParser`], or
+/// [`PacketPile::from_file`] (or related routines).
 ///
 /// Normally, you'll want to convert the `PacketPile` to a Cert or a
 /// `Message`.
diff --git a/openpgp/src/parse.rs b/openpgp/src/parse.rs
index 8403fe86..7d0be3ce 100644
--- a/openpgp/src/parse.rs
+++ b/openpgp/src/parse.rs
@@ -1,4 +1,4 @@
-//! OpenPGP packet parser.
+//! Packet parsing infrastructure.
 //!
 //! An OpenPGP message is a sequence of packets.  Some of the packets
 //! contain other packets.  These containers include encrypted packets
diff --git a/openpgp/src/serialize/mod.rs b/openpgp/src/serialize/mod.rs
index 0fc09f8a..e514a2c1 100644
--- a/openpgp/src/serialize/mod.rs
+++ b/openpgp/src/serialize/mod.rs
@@ -1,4 +1,4 @@
-//! OpenPGP packet serializer.
+//! Packet serialization infrastructure.
 //!
 //! There are two interfaces to serialize OpenPGP data.  Which one is
 //! applicable depends on whether or not the packet structure is
diff --git a/openpgp/src/types/mod.rs b/openpgp/src/types/mod.rs
index 6f9422cc..93516f16 100644
--- a/openpgp/src/types/mod.rs
+++ b/openpgp/src/types/mod.rs
@@ -1,4 +1,4 @@
-//! Primitive OpenPGP types.
+//! Primitive types.
 //!
 //! This module provides types used in OpenPGP, like enumerations
 //! describing algorithms.