Fix cargo doc warnings

Author: Alenar

mithril-aggregator/src/certificate_creator.rs

@@ -14,9 +14,9 @@ pub enum CertificateCreationError {
     Codec(String),
 }
 
-/// Define a way to create a [Certificate]
+/// Define a way to create a [Certificate][mithril_common::entities::Certificate]
 pub trait CertificateCreator {
-    /// Create a [Certificate]
+    /// Create a [Certificate][mithril_common::entities::Certificate]
     fn create_certificate(
         working: &WorkingCertificate,
         signatures_party_ids: &[PartyId],

mithril-common/src/entities/epoch.rs

@@ -33,17 +33,17 @@ impl Epoch {
         Ok(Epoch(epoch_new as u64))
     }
 
-    /// Apply the [Self::SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
+    /// Apply the [retrieval offset][Self::SIGNER_RETRIEVAL_OFFSET] to this epoch
     pub fn offset_to_signer_retrieval_epoch(&self) -> Result<Self, EpochError> {
         self.offset_by(Self::SIGNER_RETRIEVAL_OFFSET)
     }
 
-    /// Apply the [Self::NEXT_SIGNER_EPOCH_RETRIEVAL_OFFSET] to this epoch
+    /// Apply the [next signer retrieval offset][Self::NEXT_SIGNER_RETRIEVAL_OFFSET] to this epoch
     pub fn offset_to_next_signer_retrieval_epoch(&self) -> Self {
         *self + Self::NEXT_SIGNER_RETRIEVAL_OFFSET
     }
 
-    /// Apply the [Self::SIGNER_EPOCH_RECORDING_OFFSET] to this epoch
+    /// Apply the [recording offset][Self::SIGNER_RECORDING_OFFSET] to this epoch
     pub fn offset_to_recording_epoch(&self) -> Self {
         *self + Self::SIGNER_RECORDING_OFFSET
     }

mithril-common/src/test_utils/mod.rs

@@ -1,3 +1,12 @@
+//! Test utilities
+//!
+//! They contains:
+//! * A Open Api Spec tester
+//! * Some precomputed fake data
+//! * A builder of [MithrilFixture] to generate signers alongside a stake distribution
+//!
+//! Note: Most of those tools are behind the `test_only` features.
+
 #[cfg(any(test, feature = "test_only"))]
 pub mod apispec;
 #[cfg(any(test, feature = "test_only"))]