From 1b1c271531d5d4919ca1b06ea19b1f8acb52c844 Mon Sep 17 00:00:00 2001 From: Floris Bruynooghe Date: Tue, 10 Nov 2020 21:00:05 +0100 Subject: [PATCH 1/2] Trival docs typo --- metrics/src/key.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metrics/src/key.rs b/metrics/src/key.rs index 6e86105..c0844bf 100644 --- a/metrics/src/key.rs +++ b/metrics/src/key.rs @@ -9,7 +9,7 @@ use core::{ /// Inner representation of [`Key`]. /// -/// While [`Key`] is the type that users will interact with via [`Recorder`][crate::Recorder`, +/// While [`Key`] is the type that users will interact with via [`Recorder`][crate::Recorder], /// [`KeyData`] is responsible for the actual storage of the name and label data. #[derive(PartialEq, Eq, Hash, Clone, Debug)] pub struct KeyData { From 4fafc34869bffa0ffbe5b595d0c8098fd43c4fb7 Mon Sep 17 00:00:00 2001 From: Floris Bruynooghe Date: Tue, 10 Nov 2020 21:06:25 +0100 Subject: [PATCH 2/2] Add docs build to CI This should avoid accidentally breaking docs. --- .github/workflows/ci.yml | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 95bd4c4..0feed38 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -35,6 +35,23 @@ jobs: override: true - name: Run Tests run: cargo test + docs: + runs-on: ubuntu-latest + env: + RUSTDOCFLAGS: -Dwarnings + steps: + - uses: actions/checkout@v2 + - name: Install Rust Nightly + uses: actions-rs/toolchain@v1 + with: + toolchain: nightly + override: true + components: rust-docs + - name: Check docs + uses: actions-rs/cargo@v1 + with: + command: doc + args: --workspace --no-deps bench: name: Bench ${{ matrix.os }} runs-on: ${{ matrix.os }} @@ -49,4 +66,4 @@ jobs: toolchain: 'stable' override: true - name: Run Benchmarks - run: cargo bench \ No newline at end of file + run: cargo bench