From 0242873a232abcaf60d2fdc149bd77041bb87df4 Mon Sep 17 00:00:00 2001 From: Julien Cretin Date: Mon, 12 Oct 2020 16:25:25 +0200 Subject: [PATCH] Improve comments --- libraries/persistent_store/src/format.rs | 3 ++- libraries/persistent_store/src/lib.rs | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/libraries/persistent_store/src/format.rs b/libraries/persistent_store/src/format.rs index f0c910f..147f318 100644 --- a/libraries/persistent_store/src/format.rs +++ b/libraries/persistent_store/src/format.rs @@ -109,7 +109,8 @@ impl Format { /// - There are at least 3 pages. /// - There are at most [`MAX_PAGE_INDEX`]` + 1` pages. /// - A word can be written at least twice between erase cycles. - /// - A page can be erased at most [`MAX_ERASE_CYCLE`] times. + /// - The maximum number of erase cycles (i.e. the maximum number of times a page can be erased) + /// is at most [`MAX_ERASE_CYCLE`]. /// /// [`MAX_PAGE_SIZE`]: constant.MAX_PAGE_SIZE.html /// [`MAX_PAGE_INDEX`]: constant.MAX_PAGE_INDEX.html diff --git a/libraries/persistent_store/src/lib.rs b/libraries/persistent_store/src/lib.rs index 0ab47a4..f168e89 100644 --- a/libraries/persistent_store/src/lib.rs +++ b/libraries/persistent_store/src/lib.rs @@ -39,9 +39,9 @@ //! //! The store provides the following _updates_: //! - Given a key and a value, `Insert` updates the store such that the value is -//! associated with the key. The value for other keys are left unchanged. +//! associated with the key. The values for other keys are left unchanged. //! - Given a key, `Remove` updates the store such that no value is associated for -//! the key. The value for other keys are left unchanged. Additionally, if there +//! the key. The values for other keys are left unchanged. Additionally, if there //! was a value associated with the key, the value is wiped from the storage //! (all its bits are set to 0). //!