From 5b860cb9893ded811150f9ae0332dc89f166ea6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= Date: Mon, 2 Dec 2024 10:06:35 +0100 Subject: [PATCH] Fix english in the doc --- crates/milli/src/update/new/channel.rs | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/crates/milli/src/update/new/channel.rs b/crates/milli/src/update/new/channel.rs index 1a463be1e..7375354aa 100644 --- a/crates/milli/src/update/new/channel.rs +++ b/crates/milli/src/update/new/channel.rs @@ -27,9 +27,9 @@ use crate::{CboRoaringBitmapCodec, DocumentId, Index}; /// Creates a tuple of senders/receiver to be used by /// the extractors and the writer loop. /// -/// The `total_bbbuffer_capacity` represent the number of bytes -/// allocated to all BBQueue buffer. It will be split by the -/// number of thread. +/// The `total_bbbuffer_capacity` represents the number of bytes +/// allocated to all BBQueue buffers. It will be split by the +/// number of threads. /// /// The `channel_capacity` parameter defines the number of /// too-large-to-fit-in-BBQueue entries that can be sent through @@ -37,14 +37,9 @@ use crate::{CboRoaringBitmapCodec, DocumentId, Index}; /// sure we do not use too much memory. /// /// Note that the channel is also used to wake-up the receiver -/// wehn new stuff is available in any BBQueue buffer but we send +/// when new stuff is available in any BBQueue buffer but we send /// a message in this queue only if it is empty to avoid filling /// the channel *and* the BBQueue. -/// -/// # Safety -/// -/// Panics if the number of provided BBQueues is not exactly equal -/// to the number of available threads in the rayon threadpool. pub fn extractor_writer_bbqueue( bbbuffers: &mut Vec, total_bbbuffer_capacity: usize, @@ -82,7 +77,7 @@ pub struct ExtractorBbqueueSender<'a> { /// The capacity of this frame producer, will never be able to store more than that. /// /// Note that the FrameProducer requires up to 9 bytes to encode the length, - /// the capacity has been shrinked accordingly. + /// the capacity has been shrunk accordingly. /// /// capacity: usize,