about summary refs log tree commit diff
path: root/finito-core/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'finito-core/src/lib.rs')
-rw-r--r--finito-core/src/lib.rs11
1 files changed, 6 insertions, 5 deletions
diff --git a/finito-core/src/lib.rs b/finito-core/src/lib.rs
index a622134a1139..0fdb2bd912b8 100644
--- a/finito-core/src/lib.rs
+++ b/finito-core/src/lib.rs
@@ -69,7 +69,7 @@
 //! documentation. Unfortunately those assumptions are not
 //! automatically verifiable in Rust.
 //!
-//! == Example
+//! ## Example
 //!
 //! Please consult `finito-door` for an example representing a simple,
 //! lockable door as a finite-state machine. This gives an overview
@@ -88,15 +88,16 @@
 //!
 //! Currently, those libraries include:
 //!
-//!   * @finito@: Core components and classes of Finito
+//!   * `finito`: Core components and classes of Finito
 //!
-//!   * @finito-in-mem@: In-memory implementation of state machines
+//!   * `finito-in-mem`: In-memory implementation of state machines
 //!     that do not need to live longer than an application using
 //!     standard library concurrency primitives.
 //!
-//!   * @finito-postgres@: Postgres-backed, persistent implementation
+//!   * `finito-postgres`: Postgres-backed, persistent implementation
 //!     of state machines that, well, do need to live longer. Uses
-//!     Postgres for concurrency synchronisation, so keep that in mind.
+//!     Postgres for concurrency synchronisation, so keep that in
+//!     mind.
 //!
 //! Which should cover most use-cases. Okay, enough prose, lets dive
 //! in.