diff options
author | Neal H. Walfield <neal@pep.foundation> | 2020-04-02 20:31:45 +0200 |
---|---|---|
committer | Neal H. Walfield <neal@pep.foundation> | 2020-04-03 11:33:59 +0200 |
commit | 3827857fe474fc0c03c12525a9755c3326a5a2cf (patch) | |
tree | 8deb52e3a6ad53198bb47726288e06ffa9b4b925 | |
parent | 3caedcee8a26153c95fd6c35a103433620283d45 (diff) |
openpgp: Fix some documentation.
-rw-r--r-- | openpgp/src/cert/component_iter.rs | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/openpgp/src/cert/component_iter.rs b/openpgp/src/cert/component_iter.rs index 8d464c4b..b71aa2ed 100644 --- a/openpgp/src/cert/component_iter.rs +++ b/openpgp/src/cert/component_iter.rs @@ -8,7 +8,7 @@ use crate::{ policy::Policy, }; -/// An iterator over all components in a certificate. +/// An iterator over all component bundles of a given type in a certificate. /// /// `ComponentIter` follows the builder pattern. There is no need to /// explicitly finalize it, however: it already implements the @@ -47,8 +47,8 @@ impl<'a, C> ComponentIter<'a, C> { } } - /// Changes the iterator to only return components that are valid at - /// time `time`. + /// Changes the iterator to only return components that are valid + /// for the given policy at the specified time. /// /// If `time` is None, then the current time is used. /// @@ -67,7 +67,8 @@ impl<'a, C> ComponentIter<'a, C> { } } -/// An iterator over all valid `Component`s in a certificate. +/// An iterator over all valid `Component`s of a given type in a +/// certificate. /// /// A component is valid at time `t` if it was not created after `t` /// and it has a live self-signature at time `t`. |