Reinstate warn(missing_docs) on client cli and fix most warnings

Author: Alenar

mithril-client-cli/src/lib.rs

@@ -1,2 +1,11 @@
+#![warn(missing_docs)]
+
+//! A command line interface that uses the [Mithril Client Library](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client-library)
+//! to manipulate Mithril certified types from a Mithril Aggregator:
+//! * Snapshots: List, Show, download and verify
+//! * Mithril Stake Distribution: List, download and verify
+//
+//! You can find more information on how it works reading the [documentation website](https://mithril.network/doc/mithril/mithril-network/client).
+
 pub mod configuration;
 pub mod utils;

mithril-client-cli/src/utils/expander.rs

@@ -2,6 +2,7 @@ use anyhow::anyhow;
 use futures::Future;
 use mithril_common::StdResult;
 
+/// Utilities to expand aliases into their associated ids.
 pub struct ExpanderUtils;
 
 impl ExpanderUtils {

mithril-client-cli/src/utils/mod.rs

@@ -1,5 +1,5 @@
 //! Utilities module
-//! This module contains tools needed mostly in services layers.
+//! This module contains tools needed for the commands layer.
 
 mod expander;
 mod feedback_receiver;

mithril-client-cli/src/utils/progress_reporter.rs

@@ -72,9 +72,11 @@ impl Deref for ProgressPrinter {
     }
 }
 
+/// Utility to format a [ProgressBar] status as json
 pub struct ProgressBarJsonFormatter;
 
 impl ProgressBarJsonFormatter {
+    /// Get a json formatted string given the progress bar status
     pub fn format(progress_bar: &ProgressBar) -> String {
         format!(
             r#"{{"timestamp": "{}", "bytes_downloaded": {}, "bytes_total": {}, "seconds_left": {}.{:0>3}, "seconds_elapsed": {}.{:0>3}}}"#,
@@ -97,7 +99,7 @@ pub struct DownloadProgressReporter {
 }
 
 impl DownloadProgressReporter {
-    /// Instanciate a new progress reporter
+    /// Instantiate a new progress reporter
     pub fn new(progress_bar: ProgressBar, output_type: ProgressOutputType) -> Self {
         Self {
             progress_bar,
@@ -129,6 +131,7 @@ impl DownloadProgressReporter {
         };
     }
 
+    /// Report that the current download is finished and print the given message.
     pub fn finish(&self, message: &str) {
         self.progress_bar.finish_with_message(message.to_string());
     }