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 authored Sep 26, 2024
1 parent 2bed5c9 commit 44a7509
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]

#[macro_use]
extern crate static_assertions;
Expand Down

0 comments on commit 44a7509

Please sign in to comment.