Fix doc warnings (#29537)

This commit is contained in:
Brian Anderson 2023-01-07 03:24:50 -06:00 committed by GitHub
parent e92f93c290
commit 43a0745b37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 9 deletions

View File

@ -35,21 +35,28 @@ pub enum ProcessingDecision {
/// Assume transactions with same letter conflict with each other. A typical priority ordered
/// buffer might look like:
///
/// // [A, A, B, A, C, D, B, C, D]
/// ```text
/// [A, A, B, A, C, D, B, C, D]
/// ```
///
/// If we want to have batches of size 4, the MultiIteratorScanner will proceed as follows:
///
/// // [A, A, B, A, C, D, B, C, D]
/// // ^ ^ ^ ^
/// ```text
/// [A, A, B, A, C, D, B, C, D]
/// ^ ^ ^ ^
///
/// // [A, A, B, A, C, D, B, C, D]
/// // ^ ^ ^ ^
/// [A, A, B, A, C, D, B, C, D]
/// ^ ^ ^ ^
///
/// [A, A, B, A, C, D, B, C, D]
/// ^
/// ```
///
/// // [A, A, B, A, C, D, B, C, D]
/// // ^
/// The iterator will iterate with batches:
///
/// // [[A, B, C, D], [A, B, C, D], [A]]
/// ```text
/// [[A, B, C, D], [A, B, C, D], [A]]
/// ```
///
pub struct MultiIteratorScanner<'a, T, U, F>
where

View File

@ -641,7 +641,7 @@ pub trait ProtobufColumn: Column {
/// essentially Slot (or more generally speaking, has a 1:1 mapping to Slot).
///
/// The clean-up of any LedgerColumn that implements SlotColumn is managed by
/// [`LedgerCleanupService`], which will periodically deprecate and purge
/// `LedgerCleanupService`, which will periodically deprecate and purge
/// oldest entries that are older than the latest root in order to maintain the
/// configured --limit-ledger-size under the validator argument.
pub trait SlotColumn<Index = u64> {}