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.

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

Documentation failed to build #19

Open
epage opened this issue Dec 4, 2019 · 1 comment
Open

Documentation failed to build #19

epage opened this issue Dec 4, 2019 · 1 comment

Comments

@epage
Copy link
Contributor

epage commented Dec 4, 2019

[INFO] [stderr]  Documenting conventional v0.5.0 (/opt/rustwide/workdir)
[INFO] [stderr] error: Missing code example in this documentation
[INFO] [stderr]   --> src/commit.rs:12:1
[INFO] [stderr]    |
[INFO] [stderr] 12 | /// A conventional commit.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr] note: lint level defined here
[INFO] [stderr]   --> src/lib.rs:79:5
[INFO] [stderr]    |
[INFO] [stderr] 79 |     rustdoc,
[INFO] [stderr]    |     ^^^^^^^
[INFO] [stderr]    = note: `#[deny(missing_doc_code_examples)]` implied by `#[deny(rustdoc)]`
[INFO] [stderr] 
@epage
Copy link
Contributor Author

epage commented Dec 4, 2019

My recommendation is that lib.rs should not turn warnings into errors but the CI should with a pinned rustc.

  • Faster iteration for developers since they don't have to worry about an idea they are experimenting with to be perfect.
  • You only fail what you test
  • Warnings can evolve over time, breaking your CI unexpectedly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant