update documentation

Author: ghubertpalo

docs/root/mithril/mithril-network/images/signer-runtime.jpg

@@ -87,7 +87,7 @@ impl EraEpochToken {
 }
 
 /// The EraReader is responsible of giving the current Era and the Era to come.
-/// Is uses an [EraReaderAdapter] to read data from a backend.
+/// It uses an [EraReaderAdapter] to read data from a backend.
 pub struct EraReader {
     adapter: Box<dyn EraReaderAdapter>,
 }
@@ -105,8 +105,7 @@ pub enum EraReaderError {
         error: Box<dyn StdError + Sync + Send>,
     },
 
-    /// Data returned from the adapter are inconsistent or incomplete preventing
-    /// the determined the current [EraMarker].
+    /// Data returned from the adapter are inconsistent or incomplete.
     #[error("Current Era could not be determined with data from the adapter.")]
     CurrentEraNotFound,
 }

mithril-common/src/era/era_reader.rs

@@ -20,7 +20,7 @@ impl SupportedEra {
 
 /// Error related to [SupportedEra] String parsing implementation.
 #[derive(Error, Debug)]
-#[error("Unable to transform era '{0}' into a currently supported era ('thales').")]
+#[error("Unable to transform era '{0}' into a currently supported era.")]
 pub struct UnsupportedEraError(String);
 
 impl FromStr for SupportedEra {

mithril-common/src/era/supported_era.rs

@@ -13,19 +13,19 @@ pub enum SignerState {
     /// Hold the latest known epoch in order to help synchronisation
     /// with the aggregator
     Unregistered {
-        /// Unregistered state may know its epoch (None at startup). The given
-        /// epoch corresponds to the previous epoch in order to be able to
-        /// register stake distribution.
+        /// Current Epoch
         epoch: Epoch,
     },
 
-    /// `Registered` state
+    /// `Registered` state. The Signer has successfuly registered against the
+    /// Aggregator for this Epoch, it is now able to sign.
     Registered {
         /// Beacon when Signer may sign.
         beacon: Beacon,
     },
 
-    /// `Signed` state
+    /// `Signed` state. The Signer has signed the immutable files for the
+    /// current Beacon.
     Signed {
         /// Beacon when Signer signed.
         beacon: Beacon,