diff --git a/.github/workflows/cargo-doc.yaml b/.github/workflows/cargo-doc.yaml new file mode 100644 index 0000000000..6402185039 --- /dev/null +++ b/.github/workflows/cargo-doc.yaml @@ -0,0 +1,27 @@ +name: Publish Cargo Doc + +on: + push: + branches: + - master + pull_request: {} + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + + - run: cargo doc + + - name: Deploy + if: ${{ github.ref == 'ref/head/master' }} + uses: peaceiris/actions-gh-pages@v3 + with: + deploy_key: ${{ secrets.IBC_RS_DOC_PRIVATE_KEY }} + external_repository: informalsystems/ibc-rs-doc + publish_dir: ./target/doc diff --git a/docs/architecture/adr-007-error.md b/docs/architecture/adr-007-error.md index 95d072fc6b..2faf45cd23 100644 --- a/docs/architecture/adr-007-error.md +++ b/docs/architecture/adr-007-error.md @@ -7,7 +7,7 @@ ## Context This document describes the reason behind the switch from using -[`anomaly`](https://docs.rs/anomaly) for error handling to +`anomaly` for error handling to the [`flex-error`](https://docs.rs/flex-error/) crate that is developed in-house. ## Decision diff --git a/modules/src/applications/mod.rs b/modules/src/applications/mod.rs index e40402d145..ba4fb6a29b 100644 --- a/modules/src/applications/mod.rs +++ b/modules/src/applications/mod.rs @@ -9,7 +9,7 @@ pub mod ics27_interchain_accounts { /// of the full port identifier, which has a /// complex structure. /// - /// https://github.com/cosmos/ibc/tree/master/spec/app/ics-027-interchain-accounts#registering--controlling-flows + /// pub const PORT_ID_PREFIX: &str = "ics27-1."; /// ICS27 application current version. diff --git a/modules/src/clients/ics07_tendermint/client_state.rs b/modules/src/clients/ics07_tendermint/client_state.rs index 0341bc1a64..196872dec1 100644 --- a/modules/src/clients/ics07_tendermint/client_state.rs +++ b/modules/src/clients/ics07_tendermint/client_state.rs @@ -150,8 +150,7 @@ impl ClientState { elapsed > self.trusting_period } - /// Helper method to produce a - /// [`tendermint_light_client::light_client::Options`] struct for use in + /// Helper method to produce a [`Options`] struct for use in /// Tendermint-specific light client verification. pub fn as_light_client_options(&self) -> Result { Ok(Options { diff --git a/modules/src/core/ics23_commitment/merkle.rs b/modules/src/core/ics23_commitment/merkle.rs index aa79f1d1bf..ef882811de 100644 --- a/modules/src/core/ics23_commitment/merkle.rs +++ b/modules/src/core/ics23_commitment/merkle.rs @@ -35,7 +35,7 @@ pub struct MerkleProof { /// Convert to ics23::CommitmentProof /// The encoding and decoding shouldn't fail since ics23::CommitmentProof and ibc_proto::ics23::CommitmentProof should be the same -/// Ref. https://github.com/informalsystems/ibc-rs/issues/853 +/// Ref. impl From for MerkleProof { fn from(proof: RawMerkleProof) -> Self { let proofs: Vec = proof diff --git a/modules/src/lib.rs b/modules/src/lib.rs index 0fc598848d..208780e900 100644 --- a/modules/src/lib.rs +++ b/modules/src/lib.rs @@ -6,7 +6,6 @@ #![allow(clippy::large_enum_variant)] #![deny( warnings, - // missing_docs, trivial_casts, trivial_numeric_casts, unused_import_braces, diff --git a/modules/src/timestamp.rs b/modules/src/timestamp.rs index 64097f477d..477afe43fa 100644 --- a/modules/src/timestamp.rs +++ b/modules/src/timestamp.rs @@ -134,7 +134,7 @@ impl Timestamp { self.time.map(Into::into) } - /// Convert a `Timestamp` to an optional [`Tendermint::Time`] + /// Convert a `Timestamp` to an optional [`tendermint::Time`] pub fn into_tm_time(self) -> Option