diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2019-09-10 15:36:23 +0200 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2019-09-10 15:36:23 +0200 |
| commit | 8f1b04c2ff0a06b4a2a43230a03da1b2745f0e8c (patch) | |
| tree | 1380cfe3f12c7a3f663d2d6cc822aa7557840a44 /openpgp/src | |
| parent | 24f5a3b41d45c1da7b77d5cc3f496b11c8195e18 (diff) | |
openpgp: Improve documentation.
- Don't mention private method PacketParser::plausible in public
docs.
Diffstat (limited to 'openpgp/src')
| -rw-r--r-- | openpgp/src/packet/header.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/openpgp/src/packet/header.rs b/openpgp/src/packet/header.rs index 5eaa0044..4085012d 100644 --- a/openpgp/src/packet/header.rs +++ b/openpgp/src/packet/header.rs @@ -30,8 +30,9 @@ impl Header { /// /// [length encoding]: https://tools.ietf.org/html/rfc4880#section-4.2.2.4 /// - /// This function does not check the packet's content. Use - /// `PacketParser::plausible` for that. + /// This function does not check the packet's content. + // Note: To check the packet's content, use + // `PacketParser::plausible`. pub fn valid(&self, future_compatible: bool) -> Result<()> { let tag = self.ctb.tag; |