Skip to content
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

Jump to bottom

cargo doc warns but make ci does not notice them #989

Open
EdJoPaTo opened this issue Mar 19, 2024 · 0 comments
Open

cargo doc warns but make ci does not notice them #989

EdJoPaTo opened this issue Mar 19, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@EdJoPaTo
Copy link
Member

Description

cargo doc outputs warnings on documentation inconsistencies we should honor.

The Makefile seems to use cargo rustdoc instead, and I am not sure why.

To Reproduce

$ cargo doc --all-features --no-deps
…
warning: `ratatui` (lib doc) generated 5 warnings
…

Expected behavior

The CI should find and prevent such mistakes.
@EdJoPaTo EdJoPaTo added the bug Something isn't working label Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@EdJoPaTo