Skip to content

Commit

Permalink
Enforce API documentation
Browse files Browse the repository at this point in the history
Currently almost nobody documents added functions which is not good
for the users of this library - but the API must have documentation.

Let's warn about missing docs (deny would be even better).
  • Loading branch information
pravic committed Sep 28, 2024
1 parent 1e9731f commit bb7fbff
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ rust-version = "1.70.0"
[lints.rust]
rust_2018_idioms = { level = "warn", priority = -1 }
unreachable_pub = "warn"
# TODO: missing_docs = "warn"
missing_docs = "warn"
unexpected_cfgs = "allow" # for `docsrs`

[lints.clippy]
Expand Down

0 comments on commit bb7fbff

Please sign in to comment.