Skip to content

feat: add documentation checks to CI pipeline #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sukuna0007Abhi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add documentation checks to CI pipeline #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ jobs:
run: cargo fmt --all -- --check
- name: Clippy checks
run: cargo clippy --all-targets -- -D clippy::all -D clippy::cargo -A clippy::multiple-crate-versions
- name: Documentation checks
run: RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --document-private-items
- name: Build
run: cargo build --verbose
- name: Run tests
Expand Down
3 changes: 3 additions & 0 deletions src/token/base64.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ pub fn decode_str(v: &str) -> Result<Vec<u8>, Error> {
}

/// a `Vec<u8>` encoded as base64 in human readable serialization
#[allow(dead_code)]
Copy link
Contributor

@setrofim setrofim Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't right. Please remove this and the other dead code allows in this pull. None of that should be dead code. If it's being reported as such then something else is going wrong (note: I've checked locally on the latest main, and I'm not seeing any dead code warnings without these allows).

#[derive(Debug, PartialEq)]
pub struct Bytes(Vec<u8>);

#[allow(dead_code)]
impl Bytes {
pub fn new() -> Self {
Bytes(Vec::new())
Expand Down Expand Up @@ -73,6 +75,7 @@ impl<'de> Deserialize<'de> for Bytes {
}
}

#[allow(dead_code)]
struct BytesVisitor;

impl Visitor<'_> for BytesVisitor {
Expand Down