From: Matt Corallo <git@bluematt.me>
Date: Thu, 8 Feb 2024 06:19:06 +0000 (+0000)
Subject: Clean up some comments
X-Git-Tag: v0.5.4~82
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=dc8996dd008fbf0ec3123c58c1a7024f5003dfc6;p=dnssec-prover

Clean up some comments
---

diff --git a/src/lib.rs b/src/lib.rs
index c7027b0..0cabe01 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -14,7 +14,7 @@
 //! It is no-std (but requires `alloc`) and seeks to have minimal dependencies and a reasonably
 //! conservative MSRV policy, allowing it to be used in as many places as possible.
 //!
-//! Most of the crate's logic is feature-gated:
+//! Most of the crate's logic is feature-gated, and *all dependencies are optional*:
 //!  * By default, the `validate` feature is set, using `ring` to validate DNSSEC signatures and
 //!    proofs using the [`validation`] module.
 //!  * The `std` feature enables the [`query`] module, allowing for the building of proofs by
diff --git a/src/validation.rs b/src/validation.rs
index 892cbf5..999f787 100644
--- a/src/validation.rs
+++ b/src/validation.rs
@@ -200,7 +200,8 @@ where T: IntoIterator<IntoIter = I>, I: Iterator<Item = &'a DS> + Clone {
 /// Given a set of [`RR`]s, [`verify_rr_stream`] checks what it can and returns the set of
 /// non-[`RRSig`]/[`DnsKey`]/[`DS`] records which it was able to verify using this struct.
 ///
-/// It also contains
+/// It also contains signing and expiry times, which must be validated before considering the
+/// contained records verified.
 #[derive(Debug, Clone)]
 pub struct VerifiedRRStream<'a> {
 	/// The set of verified [`RR`]s.