Skip to content

Commit

Permalink
Reword top-level doc
Browse files Browse the repository at this point in the history
  • Loading branch information
zakarumych committed Dec 28, 2023
1 parent 095b5e0 commit 3998c7c
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
#![doc = include_str!("../README.md")]
//!
//! The root module exports public API sufficient for most use cases.
//! Except manual implementation and direct usage of `Buffer`, `Formula`,
//! `Serialize` and `Deserialize` traits and `Deserializer` type.
//! For those use cases, see `advanced` module.
//!
//! For manual implementation and direct usage of `Buffer`, `Formula`,
//! `Serialize` and `Deserialize` traits and `Deserializer` type
//! see [`advanced`] module.
#![cfg_attr(not(feature = "std"), no_std)]
#![forbid(unsafe_code)]
#![deny(missing_docs)]
#![deny(
clippy::correctness,
clippy::suspicious,
clippy::complexity,
clippy::perf,
clippy::style
)]

#[cfg(test)]
extern crate self as alkahest;
Expand Down

0 comments on commit 3998c7c

Please sign in to comment.