Merge branch 'main' into feature/add-SECURITY-md

Author: minikin

src/chain-libs/chain-storage/src/lib.rs

@@ -41,7 +41,7 @@
 //! __fig.1 - note that root does not actually exist, this is an ID referredby__
 //! __the first block in the chain__
 //!
-//! ```ignore
+//! ```text
 //! +---------+       +---------+
 //! |         |       |         |
 //! | Block 4 |       | Block 4'|
@@ -104,7 +104,7 @@
 //!
 //! __fig. 2 - permanent storage structure__
 //!
-//! ```ignore
+//! ```text
 //! store                  block no. index
 //!
 //! +--------------+       +-------------+
@@ -128,7 +128,7 @@
 //!
 //! # Storage directory layout
 //!
-//! ```ignore
+//! ```text
 //! store
 //! ├── permanent       - permanent storage directory
 //! │   └── flatfile    - storage file that can be transferred over the network

src/chain-libs/chain-time/src/lib.rs

@@ -1,3 +1,5 @@
+// #![warn(clippy::all)]
+// #![deny(missing_docs)]
 pub mod era;
 pub mod timeframe;
 pub mod timeline;

src/chain-libs/chain-time/src/timeframe.rs

@@ -1,3 +1,6 @@
+//! Timeframe
+//!
+
 use crate::timeline::Timeline;
 use std::time::{Duration, SystemTime};
 

src/chain-wallet-libs/bindings/wallet-core/src/wallet.rs

@@ -35,7 +35,7 @@ impl Wallet {
     /// Retrieve a wallet from a key used as utxo's
     ///
     /// You can also use this function to recover a wallet even after you have
-    /// transferred all the funds to the new format (see the [Self::convert] function).
+    /// transferred all the funds to the new format
     ///
     /// Parameters
     ///

src/chain-wallet-libs/chain-path-derivation/src/bip44.rs

@@ -107,7 +107,7 @@ impl DerivationPath<Bip44<Root>> {
     /// use the same "model" of 5 derivation level but instead of starting with the
     /// bip44 Hard Derivation uses the `'1852` (`'0x073C`) derivation path.
     ///
-    /// see https://input-output-hk.github.io/adrestia/docs/key-concepts/hierarchical-deterministic-wallets/
+    /// see <https://input-output-hk.github.io/adrestia/docs/key-concepts/hierarchical-deterministic-wallets/>
     ///
     pub fn chimeric(&self) -> DerivationPath<Bip44<Purpose>> {
         let mut p = self.clone();

src/jormungandr/jcli/src/jcli_lib/utils/output_format.rs

@@ -8,7 +8,7 @@ use thiserror::Error;
 pub struct OutputFormat {
     /// Format of output data. Possible values: json, yaml.
     /// Any other value is treated as a custom format using values from output data structure.
-    /// Syntax is Go text template: https://golang.org/pkg/text/template/.
+    /// Syntax is Go text template: <https://golang.org/pkg/text/template/>.
     #[structopt(long = "output-format", default_value = "yaml", parse(from_str))]
     format: FormatVariant,
 }

src/jormungandr/jormungandr-lib/src/crypto/key.rs

@@ -168,7 +168,7 @@ impl<A: AsymmetricPublicKey> Identifier<A> {
     /// encode the `Identifier` into an hexadecimal string
     ///
     /// While this is still a human readable format. it is lesser than
-    /// the output of [`to_bech32_str`] as it does not provide user input
+    /// the output of [`Self::to_bech32_str`] as it does not provide user input
     /// verification.
     ///
     /// `Display` implementation of `Identifier` provides the hexadecimal string support.

src/jormungandr/testing/mjolnir/src/mjolnir_lib/bootstrap/mod.rs

@@ -28,18 +28,18 @@ pub struct ClientLoadCommand {
     #[structopt(short = "a", long = "address")]
     pub address: String,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "p", long = "pace", default_value = "2")]
     pub pace: u64,
 
     #[structopt(short = "d", long = "storage")]
     pub initial_storage: Option<PathBuf>,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "r", long = "duration")]
     pub duration: Option<u64>,
 
-    /// amount of delay [seconds] between sync attempts
+    /// amount of delay (in seconds) between sync attempts
     #[structopt(short = "n", long = "iterations")]
     pub sync_iteration: Option<u32>,
 

src/jormungandr/testing/mjolnir/src/mjolnir_lib/explorer.rs

@@ -24,7 +24,7 @@ pub struct ExplorerLoadCommand {
     #[structopt(short = "e", long = "endpoint")]
     pub endpoint: String,
 
-    /// Amount of delay [milliseconds] between sync attempts
+    /// Amount of delay (in milliseconds) between sync attempts
     #[structopt(long = "delay", default_value = "50")]
     pub delay: u64,
 

src/jormungandr/testing/mjolnir/src/mjolnir_lib/rest.rs

@@ -24,11 +24,11 @@ pub struct RestLoadCommand {
     #[structopt(short = "e", long = "endpoint")]
     pub endpoint: String,
 
-    /// Amount of delay [milliseconds] between sync attempts
+    /// Amount of delay (in milliseconds) between sync attempts
     #[structopt(long = "delay", default_value = "50")]
     pub delay: u64,
 
-    /// Amount of delay [seconds] between sync attempts
+    /// Amount of delay (in seconds) between sync attempts
     #[structopt(short = "d", long = "duration")]
     pub duration: u64,