diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 37846d4..26c3c26 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -48,5 +48,6 @@ jobs: - name: Check README run: | - cargo install cargo-rdme + cargo install cargo-rdme --version 2.2.3 --locked + cargo rdme install-rust-toolchain-for-intralinks cargo rdme --check diff --git a/README.md b/README.md index 42edd7f..3a16fbe 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ of returning the calculated hash in different representations: * [`PoseidonBytesHasher`](https://docs.rs/light-poseidon/latest/light_poseidon/trait.PoseidonBytesHasher.html) with the `hash_bytes_be` and `hash_bytes_le` methods which returns a byte array. * [`PoseidonHasher`](https://docs.rs/light-poseidon/latest/light_poseidon/trait.PoseidonHasher.html) with the `hash` method which returns - [`ark_ff::PrimeField`](ark_ff::PrimeField). Might be useful if you want + [`ark_ff::PrimeField`](https://docs.rs/ark_ff/latest/ark_ff/fields/prime/trait.PrimeField.html). Might be useful if you want to immediately process the result with an another library which works with - [`ark_ff::PrimeField`](ark_ff::PrimeField) types. + [`ark_ff::PrimeField`](https://docs.rs/ark_ff/latest/ark_ff/fields/prime/trait.PrimeField.html) types. ## Examples @@ -64,7 +64,7 @@ println!("{:?}", hash); ``` With [`PoseidonHasher`](https://docs.rs/light-poseidon/latest/light_poseidon/trait.PoseidonHasher.html) trait and -[`ark_ff::PrimeField`](ark_ff::PrimeField) result: +[`ark_ff::PrimeField`](https://docs.rs/ark_ff/latest/ark_ff/fields/prime/trait.PrimeField.html) result: ```rust use light_poseidon::{Poseidon, PoseidonHasher, parameters::bn254_x5}; diff --git a/xtask/src/generate_parameters.rs b/xtask/src/generate_parameters.rs index 2fccf18..540bf29 100644 --- a/xtask/src/generate_parameters.rs +++ b/xtask/src/generate_parameters.rs @@ -65,7 +65,7 @@ pub fn generate_parameters(_opts: Options) -> Result<(), anyhow::Error> { .stdout(Stdio::inherit()) .stderr(Stdio::inherit()) .output() - .map_err(|e| anyhow::format_err!("git clone failed: {}", e.to_string()))?; + .map_err(|e| anyhow::format_err!("git clone failed: {}", e))?; } if !Path::new("./target/params").exists() { let _mkdir_result = std::process::Command::new("mkdir") @@ -73,7 +73,7 @@ pub fn generate_parameters(_opts: Options) -> Result<(), anyhow::Error> { .stdout(Stdio::inherit()) .stderr(Stdio::inherit()) .output() - .map_err(|e| anyhow::format_err!("mkdir failed: {}", e.to_string()))?; + .map_err(|e| anyhow::format_err!("mkdir failed: {}", e))?; } for i in 2..14 { let path = format!("./target/params/poseidon_params_bn254_x5_{}", i); @@ -240,7 +240,7 @@ pub fn generate_parameters(_opts: Options) -> Result<(), anyhow::Error> { std::process::Command::new("cargo") .arg("fmt") .output() - .map_err(|e| anyhow::format_err!("cargo fmt failed: {}", e.to_string()))?; + .map_err(|e| anyhow::format_err!("cargo fmt failed: {}", e))?; Ok(()) }