diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2020-03-31 12:26:47 +0200 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2020-03-31 12:26:47 +0200 |
| commit | 57a25564c9f08509bfa76848ae5557f792ba6805 (patch) | |
| tree | 14bf0f560728271308a9c61f253729f182bf4f3c /openpgp/src/packet_pile.rs | |
| parent | d9a168e89aab2d7a0a46c449ede166697acd0c3b (diff) | |
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.
Diffstat (limited to 'openpgp/src/packet_pile.rs')
| -rw-r--r-- | openpgp/src/packet_pile.rs | 8 |
1 files changed, 4 insertions, 4 deletions
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`. |