mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(core): Fix rustdoc syntax in several places

Browse source
This commit is contained in:
Vincent Ambo 2018-09-26 18:02:55 +02:00
parent 401486d124
commit 965574913e
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
finito-core/src/lib.rs
View file

@ -69,7 +69,7 @@
//! documentation. Unfortunately those assumptions are not //! documentation. Unfortunately those assumptions are not
//! automatically verifiable in Rust. //! automatically verifiable in Rust.
//! //!
//! == Example //! ## Example
//! //!
//! Please consult `finito-door` for an example representing a simple, //! Please consult `finito-door` for an example representing a simple,
//! lockable door as a finite-state machine. This gives an overview //! lockable door as a finite-state machine. This gives an overview
@ -88,15 +88,16 @@
//! //!
//! Currently, those libraries include: //! 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 //! that do not need to live longer than an application using
//! standard library concurrency primitives. //! 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 //! 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 //! Which should cover most use-cases. Okay, enough prose, lets dive
//! in. //! in.