Skip to content

Commit

Permalink
Fix doc warnings (#29537)
Browse files Browse the repository at this point in the history
  • Loading branch information
brson committed Jan 7, 2023
1 parent e92f93c commit 43a0745
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
23 changes: 15 additions & 8 deletions core/src/multi_iterator_scanner.rs
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ledger/src/blockstore_db.rs
Expand Up @@ -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> {}
Expand Down

0 comments on commit 43a0745

Please sign in to comment.