514fa55 REVIEW: reword module docs — heartwood

Radicle Heartwood Protocol & Stack

REVIEW: reword module docs

Fintan Halpenny committed 7 months ago

commit 514fa55da9dadbab73b5d654f25f7b94d85add3b
parent cc2ea18ddcb1a7c045cabd1901c5ea1e29e560ce

1 file changed +6 -4

modified crates/radicle-oid/src/lib.rs

@@ -1,6 +1,6 @@

 #![no_std]
 //! This is a `no_std` crate carries the struct [`Oid`].
 //! This is a `no_std` crate which carries the struct [`Oid`].
 //!
 //! ## Background
 //!

@@ -8,7 +8,9 @@

 //!
 //! Free from [`git2`].
 //!
 //! IDs are ubiquitious, have a struct under our control.
 //! The use of Git SHAs as identifiers is ubiquitous in the `heartwood` set of
 //! crates, so it is important that we have a `struct` that is under our
 //! control.
 //!
 //! ## Feature Flags
 //!

@@ -27,13 +29,13 @@

 //!
 //! [`git2::Oid`]: ::git2::Oid
 //!
 //! Conversions to/from [`git2::Oid`].
 //! Provides conversions to/from [`git2::Oid`].
 //!
 //! ### `gix`
 //!
 //! [`ObjectId`]: ::gix_hash::ObjectId
 //!
 //! Conversions to/from [`ObjectId`].
 //! Provides conversions to/from [`ObjectId`].
 //!
 //! ### `schemars`
 //!