docs: add missing backticks in documentation

this improve readability of documentation.
enable associated clippy lint `doc_markdown`
This commit is contained in:
Gwen Lg
2026-01-25 23:46:05 +01:00
committed by Alex
parent 6cde00073f
commit 08fd6e659f
58 changed files with 175 additions and 174 deletions
+5 -5
View File
@@ -334,7 +334,7 @@ impl<F: TableSchema, R: TableReplication> Worker for GcWorker<F, R> {
}
}
/// An entry stored in the gc_todo db tree associated with the table
/// An entry stored in the `gc_todo` db tree associated with the table
/// Contains helper function for parsing, saving, and removing
/// such entry in the db
///
@@ -352,7 +352,7 @@ pub(crate) struct GcTodoEntry {
}
impl GcTodoEntry {
/// Creates a new GcTodoEntry (not saved in the db) from its components:
/// Creates a new `GcTodoEntry` (not saved in the db) from its components:
/// the key of an entry in the table, and the hash of the associated
/// serialized value
pub(crate) fn new(key: Vec<u8>, value_hash: Hash) -> Self {
@@ -364,7 +364,7 @@ impl GcTodoEntry {
}
}
/// Parses a GcTodoEntry from a (k, v) pair stored in the gc_todo tree
/// Parses a `GcTodoEntry` from a (k, v) pair stored in the `gc_todo` tree
pub(crate) fn parse(db_k: &[u8], db_v: &[u8]) -> Self {
Self {
tombstone_timestamp: u64::from_be_bytes(db_k[0..8].try_into().unwrap()),
@@ -374,13 +374,13 @@ impl GcTodoEntry {
}
}
/// Saves the GcTodoEntry in the gc_todo tree
/// Saves the `GcTodoEntry` in the `gc_todo` tree
pub(crate) fn save(&self, gc_todo_tree: &db::Tree) -> Result<(), Error> {
gc_todo_tree.insert(self.todo_table_key(), self.value_hash.as_slice())?;
Ok(())
}
/// Removes the GcTodoEntry from the gc_todo tree if the
/// Removes the `GcTodoEntry` from the `gc_todo` tree if the
/// hash of the serialized value is the same here as in the tree.
/// This is useful to remove a todo entry only under the condition
/// that it has not changed since the time it was read, i.e.
+1 -1
View File
@@ -2,7 +2,7 @@ use opentelemetry::{global, metrics::*, KeyValue};
use garage_db as db;
/// TableMetrics reference all counter used for metrics
/// `TableMetrics` reference all counter used for metrics
pub struct TableMetrics {
pub(crate) _table_size: ValueObserver<u64>,
pub(crate) _merkle_tree_size: ValueObserver<u64>,
+1 -1
View File
@@ -22,7 +22,7 @@ impl PartitionKey for String {
}
}
/// Values of type FixedBytes32 are assumed to be random,
/// Values of type `FixedBytes32` are assumed to be random,
/// either a hash or a random UUID. This means we can use
/// them directly as an index into the hash table.
impl PartitionKey for FixedBytes32 {