Skip to content

Commit 85afcd6

Browse files
committed
docs: adjustements from the PR reviews and fix typos
1 parent 4233b71 commit 85afcd6

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

mithril-client/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ default = ["native-tls", "rug-backend", "enable-http-compression"]
9393
# Full feature set
9494
full = ["fs"]
9595

96-
# Enable file system related functionnality, right now that mean ony snapshot download
96+
# Enable file system related functionality, right now that mean only snapshot download
9797
fs = ["flate2", "flume", "tar", "tokio/rt", "zstd"]
9898
portable = [] # deprecated, will be removed soon
9999
unstable = []

mithril-client/src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@
7070
//!
7171
//! - **fs**: Enables file system related functionalities.
7272
//! - **unstable**: Enables experimental or in-development `mithril-client` features that may change.
73+
//! - **rug-backend** *(enabled by default)*: Enables usage of `rug` numerical backend in `mithril-stm` (dependency of `mithril-common`).
74+
//! - **num-integer-backend**: Enables usage of `num-integer` numerical backend in `mithril-stm` (dependency of `mithril-common`).
75+
//!
76+
//! To allow fine tuning of the http queries, the following [Reqwest](https://docs.rs/reqwest/latest/reqwest/#optional-features) features are re-exported:
7377
//! - **native-tls** *(enabled by default)*: Enables TLS functionality provided by `native-tls`.
7478
//! - **native-tls-vendored**: Enables the `vendored` feature of `native-tls`.
7579
//! - **native-tls-alpn**: Enables the `alpn` feature of `native-tls`.
@@ -82,8 +86,6 @@
8286
//! - **rustls-tls-native-roots**: Enables TLS functionality provided by `rustls`,
8387
//! while using root certificates from the `rustls-native-certs` crate.
8488
//! - **enable-http-compression** *(enabled by default)*: Enables compressed traffic with `reqwest`.
85-
//! - **rug-backend** *(enabled by default)*: Enables usage of `rug` numerical backend in `mithril-stm` (dependency of `mithril-common`).
86-
//! - **num-integer-backend**: Enables usage of `num-integer` numerical backend in `mithril-stm` (dependency of `mithril-common`).
8789
8890
macro_rules! cfg_fs {
8991
($($item:item)*) => {

0 commit comments

Comments
 (0)