feat: add documentation checks to CI pipeline#43
Open
Sukuna0007Abhi wants to merge 1 commit intoveraison:mainfrom
Open
feat: add documentation checks to CI pipeline#43Sukuna0007Abhi wants to merge 1 commit intoveraison:mainfrom
Sukuna0007Abhi wants to merge 1 commit intoveraison:mainfrom
Conversation
- Add 'cargo doc' with RUSTDOCFLAGS="-D warnings" to CI workflow - Ensures documentation builds successfully and catches doc warnings - Include --document-private-items flag for comprehensive doc coverage - Fix dead code warnings in base64.rs using #[allow(dead_code)] - Resolves issue veraison#23: documentation should be checked by the CI The CI now validates: 1. Code formatting (cargo fmt) 2. Clippy lints 3. Documentation generation (NEW) 4. Build process 5. Test execution Signed-off-by: Sukuna0007Abhi <appsonly310@gmail.com>
setrofim
requested changes
Oct 13, 2025
| } | ||
|
|
||
| /// a `Vec<u8>` encoded as base64 in human readable serialization | ||
| #[allow(dead_code)] |
Contributor
There was a problem hiding this comment.
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Documentation checks to Cl pipeline
The CI now validates:
Fixes #23