summaryrefslogtreecommitdiffstats
path: root/openpgp/src/parse
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2019-08-21 10:50:28 +0200
committerJustus Winter <justus@sequoia-pgp.org>2019-08-21 10:50:28 +0200
commit8ebdb60fb565fe1b7c8939a02c97b2234837feea (patch)
treed2a34306c9d5c79329f678540b1bb5f574c4b706 /openpgp/src/parse
parentcb1ad1110950333b20c5d4a491c2858a3c61b1fa (diff)
openpgp: Fix documentation.
Diffstat (limited to 'openpgp/src/parse')
-rw-r--r--openpgp/src/parse/packet_pile_parser.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/openpgp/src/parse/packet_pile_parser.rs b/openpgp/src/parse/packet_pile_parser.rs
index 9efc6b9c..e1525707 100644
--- a/openpgp/src/parse/packet_pile_parser.rs
+++ b/openpgp/src/parse/packet_pile_parser.rs
@@ -39,7 +39,7 @@ use buffered_reader::BufferedReader;
/// to the packet (`&mut Packet`) that is currently being processed
/// while continuing to support streaming operations. It is also not
/// possible to return a mutable reference to the `PacketParser`.
-/// Thus, we expose the `Option<PacketParser>` directly to the user.
+/// Thus, we expose the `PacketParserResult` directly to the user.
/// *However*, do *not* directly call `PacketParser::next()` or
/// `PacketParser::recurse()`. This will break the `PacketPileParser`
/// implementation.