Skip to content

Commit 25d4df3

Browse files
committed
Doc check in CI
1 parent a112492 commit 25d4df3

3 files changed

Lines changed: 16 additions & 2 deletions

File tree

.github/workflows/ci.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,17 @@ jobs:
6363
submodules: recursive
6464
- name: Test
6565
run: cargo test --all-features
66+
67+
rustdoc:
68+
name: cargo:doc
69+
if: ${{ !github.event.pull_request.draft }}
70+
runs-on: ubuntu-latest
71+
steps:
72+
- name: Checkout
73+
uses: actions/checkout@v2
74+
with:
75+
submodules: recursive
76+
- name: Docs
77+
run: |
78+
rustup component add rust-docs
79+
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features

cargo-concordium/src/build.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ fn check_exports(module: &Module, version: WasmVersion) -> anyhow::Result<()> {
678678

679679
/// Find the string closest to the list of strings. If an exact match is found
680680
/// return `None`, otherwise return `Some` with a list of strings that are
681-
/// closest according to the [optimal string alignment metric](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance distance).
681+
/// closest according to the [optimal string alignment metric](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance).
682682
fn find_closest<'a>(
683683
list: impl IntoIterator<Item = &'a str>,
684684
goal: &'a str,

cargo-concordium/src/context.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ impl v0::HasInitContext for InitContextOpt {
5656
}
5757
}
5858

59-
/// Serde deserializer for Option<Address>.
59+
/// Serde deserializer for `Option<Address>`.
6060
/// Introduced to avoid breaking changes when the serde implementation for
6161
/// Address was changed to match the node.
6262
fn deserialize_optional_address<'de, D: serde::de::Deserializer<'de>>(

0 commit comments

Comments
 (0)