mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
Grammar and Typo Fixes in Documentation (#12789)
This commit is contained in:
@ -136,7 +136,7 @@ are only a few cases of changing data.
|
|||||||
| _DELETING_|||
|
| _DELETING_|||
|
||||||
|Key is absent → Error since no such key |\ref mdbx_del() or \ref mdbx_replace()|Error \ref MDBX_NOTFOUND|
|
|Key is absent → Error since no such key |\ref mdbx_del() or \ref mdbx_replace()|Error \ref MDBX_NOTFOUND|
|
||||||
|Key exist → Delete by key |\ref mdbx_del() with the parameter `data = NULL`|Deletion|
|
|Key exist → Delete by key |\ref mdbx_del() with the parameter `data = NULL`|Deletion|
|
||||||
|Key exist → Delete by key with with data matching check|\ref mdbx_del() with the parameter `data` filled with the value which should be match for deletion|Deletion or \ref MDBX_NOTFOUND if the value does not match|
|
|Key exist → Delete by key with data matching check|\ref mdbx_del() with the parameter `data` filled with the value which should be match for deletion|Deletion or \ref MDBX_NOTFOUND if the value does not match|
|
||||||
|Delete at the current cursor position |\ref mdbx_cursor_del() with \ref MDBX_CURRENT flag|Deletion|
|
|Delete at the current cursor position |\ref mdbx_cursor_del() with \ref MDBX_CURRENT flag|Deletion|
|
||||||
|Extract (read & delete) value by the key |\ref mdbx_replace() with zero flag and parameter `new_data = NULL`|Returning a deleted value|
|
|Extract (read & delete) value by the key |\ref mdbx_replace() with zero flag and parameter `new_data = NULL`|Returning a deleted value|
|
||||||
|
|
||||||
@ -5264,7 +5264,7 @@ LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result,
|
|||||||
* This returns a comparison as if the two data items were keys in the
|
* This returns a comparison as if the two data items were keys in the
|
||||||
* specified database.
|
* specified database.
|
||||||
*
|
*
|
||||||
* \warning There ss a Undefined behavior if one of arguments is invalid.
|
* \warning There is a Undefined behavior if one of arguments is invalid.
|
||||||
*
|
*
|
||||||
* \param [in] txn A transaction handle returned by \ref mdbx_txn_begin().
|
* \param [in] txn A transaction handle returned by \ref mdbx_txn_begin().
|
||||||
* \param [in] dbi A database handle returned by \ref mdbx_dbi_open().
|
* \param [in] dbi A database handle returned by \ref mdbx_dbi_open().
|
||||||
|
|||||||
@ -42,7 +42,7 @@ There will only ever exist one description per metric `KeyName`; it is not possi
|
|||||||
The `metrics` crate provides three macros per metric variant: `register_<metric>!`, `<metric>!`, and `describe_<metric>!`. Prefer to use these where possible, since they generate the code necessary to register and update metrics under various conditions.
|
The `metrics` crate provides three macros per metric variant: `register_<metric>!`, `<metric>!`, and `describe_<metric>!`. Prefer to use these where possible, since they generate the code necessary to register and update metrics under various conditions.
|
||||||
|
|
||||||
- The `register_<metric>!` macro simply creates the metric and returns a handle to it (e.g. a `Counter`). These metric structs are thread-safe and cheap to clone.
|
- The `register_<metric>!` macro simply creates the metric and returns a handle to it (e.g. a `Counter`). These metric structs are thread-safe and cheap to clone.
|
||||||
- The `<metric>!` macro registers the metric if it does not exist, and updates it's value.
|
- The `<metric>!` macro registers the metric if it does not exist, and updates its value.
|
||||||
- The `describe_<metric>!` macro adds an end-user description for the metric.
|
- The `describe_<metric>!` macro adds an end-user description for the metric.
|
||||||
|
|
||||||
How the metrics are exposed to the end-user is determined by the CLI.
|
How the metrics are exposed to the end-user is determined by the CLI.
|
||||||
|
|||||||
Reference in New Issue
Block a user