Merge pull request #437 from nuttycom/zcash_note_encryption_doc_fixes

Fix a couple of broken doc links.
zcash · Sep 1, 2021 · 993925e · 993925e
2 parents ee12531 + 5541552
commit 993925e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/components/zcash_note_encryption/src/batch.rs b/components/zcash_note_encryption/src/batch.rs
@@ -9,7 +9,7 @@ use crate::{
 
 /// Trial decryption of a batch of notes with a set of recipients.
 ///
-/// This is the batched version of [`zcash_note_encryption::try_note_decryption`].
+/// This is the batched version of [`crate::try_note_decryption`].
 #[allow(clippy::type_complexity)]
 pub fn try_note_decryption<D: Domain, Output: ShieldedOutput<D>>(
     ivks: &[D::IncomingViewingKey],
@@ -20,7 +20,7 @@ pub fn try_note_decryption<D: Domain, Output: ShieldedOutput<D>>(
 
 /// Trial decryption of a batch of notes for light clients with a set of recipients.
 ///
-/// This is the batched version of [`zcash_note_encryption::try_compact_note_decryption`].
+/// This is the batched version of [`crate::try_compact_note_decryption`].
 pub fn try_compact_note_decryption<D: Domain, Output: ShieldedOutput<D>>(
     ivks: &[D::IncomingViewingKey],
     outputs: &[(D, Output)],

diff --git a/components/zcash_note_encryption/src/lib.rs b/components/zcash_note_encryption/src/lib.rs
@@ -3,6 +3,11 @@
 //! functionality that is shared between the Sapling and Orchard
 //! protocols.
 
+// Catch documentation errors caused by code changes.
+#![deny(broken_intra_doc_links)]
+#![deny(unsafe_code)]
+// TODO: #![deny(missing_docs)]
+
 use std::convert::TryInto;
 
 use chacha20::{
@@ -13,6 +18,7 @@ use chacha20poly1305::{
     aead::{AeadInPlace, NewAead},
     ChaCha20Poly1305,
 };
+
 use rand_core::RngCore;
 use subtle::{Choice, ConstantTimeEq};