kmwebnet/OpenSK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve comments

Browse Source
This commit is contained in:
Julien Cretin
2020-10-12 16:25:25 +02:00
parent d721949806
commit 0242873a23
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
libraries/persistent_store/src/format.rs
View File

@@ -109,7 +109,8 @@ impl Format {
/// - There are at least 3 pages. /// - There are at least 3 pages.
/// - There are at most [`MAX_PAGE_INDEX`]` + 1` pages. /// - There are at most [`MAX_PAGE_INDEX`]` + 1` pages.
/// - A word can be written at least twice between erase cycles. /// - 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_SIZE`]: constant.MAX_PAGE_SIZE.html
/// [`MAX_PAGE_INDEX`]: constant.MAX_PAGE_INDEX.html /// [`MAX_PAGE_INDEX`]: constant.MAX_PAGE_INDEX.html

4
libraries/persistent_store/src/lib.rs
View File

@@ -39,9 +39,9 @@
//! //!
//! The store provides the following _updates_: //! The store provides the following _updates_:
//! - Given a key and a value, `Insert` updates the store such that the value is //! - 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 //! - 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 //! was a value associated with the key, the value is wiped from the storage
//! (all its bits are set to 0). //! (all its bits are set to 0).
//! //!