refactor(common, protocol-config, signer): update comments

Author: turmelclem

mithril-aggregator/src/services/message.rs

@@ -35,7 +35,7 @@ pub trait MessageService: Sync + Send {
         allowed_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
     ) -> StdResult<EpochSettingsMessage>;
 
-    ///Return the protocol configuration message for the given epoch if it exists.
+    /// Return the protocol configuration message for the given epoch if it exists.
     async fn get_protocol_configuration_message(
         &self,
         epoch: Epoch,

mithril-common/src/messages/protocol_configuration.rs

@@ -9,10 +9,10 @@ use crate::entities::{
 /// ProtocolConfiguration represents the protocol configuration of an epoch
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct ProtocolConfigurationMessage {
-    /// Signer Registration Protocol parameters
+    /// Protocol parameters
     pub protocol_parameters: ProtocolParameters,
 
-    /// Cardano transactions signing configuration for the current epoch
+    /// Cardano transactions signing configuration
     #[serde(skip_serializing_if = "Option::is_none")]
     pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 

mithril-signer/src/entities/signer_epoch_settings.rs

@@ -1,7 +1,6 @@
 use mithril_common::entities::{Epoch, Signer};
 
 /// SignerEpochSettings represents the settings of an epoch
-/// TODO: rename SignerRegistration ? SignerRegistrationSettings ?
 #[derive(Clone, Debug, PartialEq)]
 pub struct SignerEpochSettings {
     /// Current Epoch