Skip to content

Commit

Permalink
ci: Check for documentation warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
caspermeijn committed May 10, 2024
1 parent 3cf8c77 commit bf29d71
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,20 @@ jobs:
# prost's default features to compile.
- name: prost-build check
run: cargo check --manifest-path prost-build/Cargo.toml

docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: install protoc
uses: taiki-e/install-action@v2
with:
tool: protoc@${{ env.PROTOC_VERSION }}
- name: install ninja
uses: ./.github/actions/setup-ninja
- uses: dtolnay/rust-toolchain@stable
- name: "doc --lib --all-features"
run: |
cargo doc --workspace --exclude protobuf --lib --no-deps --all-features --document-private-items
env:
RUSTDOCFLAGS: -Dwarnings
2 changes: 1 addition & 1 deletion prost-build/src/code_generator/c_escaping.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use log::debug;

/// Based on [`google::protobuf::UnescapeCEscapeString`][1]
///
///
/// [1]: https://github.com/google/protobuf/blob/3.3.x/src/google/protobuf/stubs/strutil.cc#L312-L322
pub(super) fn unescape_c_escape_string(s: &str) -> Vec<u8> {
let src = s.as_bytes();
Expand Down

0 comments on commit bf29d71

Please sign in to comment.