Skip to content

Commit

Permalink
ci: update nightly and fail on doc warnings (#92)
Browse files Browse the repository at this point in the history
Currently, CI testing uses a fixed nightly toolchain. While this is
useful against a spurious nightly build, the repository already uses the
latest nightly for formatting, lints, and checks. I think it's worth it
to stick with the latest nightly across the board.

Additionally, this updates documentation checks to fail on warnings.
This ensures that the documentation warnings don't go unnoticed.
  • Loading branch information
AaronFeickert committed Oct 20, 2023
1 parent 43dd1be commit a47f511
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
matrix:
rust:
- stable
- nightly-2023-06-04
- nightly
steps:
- name: checkout
uses: actions/checkout@v4
Expand All @@ -25,4 +25,4 @@ jobs:
- name: test/release
run: cargo +${{ matrix.rust }} test --release --all-features
- name: Build documentation
run: cargo +${{ matrix.rust }} doc --no-deps
run: RUSTDOCFLAGS="-D warnings" cargo +${{ matrix.rust }} doc --no-deps
2 changes: 1 addition & 1 deletion src/protocols/scalar_protocol.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub trait ScalarProtocol {
/// Returns a non-zero random Scalar
fn random_not_zero<R: RngCore + CryptoRng>(rng: &mut R) -> Scalar;

/// Construct a scalar from an existing Blake2b instance (helper function to implement 'Scalar::from_hash<Blake2b>')
/// Construct a scalar from an existing Blake2b instance (helper function to implement `Scalar::from_hash<Blake2b>`)
fn from_hasher_blake2b(hasher: Blake2bMac512) -> Scalar;
}

Expand Down

0 comments on commit a47f511

Please sign in to comment.