docs: fix typos and grammar

Signed-off-by: Gustavo Inacio <[email protected]>

Author: gusinacio

crates/tap-agent/src/adaptative_concurrency.rs

@@ -2,25 +2,25 @@
 // SPDX-License-Identifier: Apache-2.0
 
 //! # Adaptative concurrency
-//! This module provide [AdaptiveLimiter] as a tool to allow concurrency.
-//! It's implemented with a Additive increase, Multiplicative decrease
+//! This module provides [AdaptiveLimiter] as a tool to allow concurrency.
+//! It's implemented with an Additive increase, Multiplicative decrease
 //! ([AIMD](https://en.wikipedia.org/wiki/Additive_increase/multiplicative_decrease))
 //! strategy.
 //!
 //!
 //!
 //! This allows us to have a big number of rav requests running
-//! concurrently, but in case of any of them fails, we limit
+//! concurrently, but if any of them fails we limit
 //! the following requests until the aggregator recovers.
 //!
 //! ## Behaviour
-//! On every request, the caller acquires a slot by calling [AdaptiveLimiter::acquire()],
-//! this will increment the number of in_flight connections.
+//! On every request, the caller acquires a slot by calling [AdaptiveLimiter::acquire()].
+//! This will increment the number of in_flight connections.
 //!
 //! If we receive a successful response, we increment our limit to be able to process
 //! one more request concurrently.
 //!
-//! If we receive a failed response, we decrement our limit by half so quickly
+//! If we receive a failed response, we decrement our limit by half to quickly
 //! relieve the pressure in the system.
 
 use std::ops::Range;

crates/tap-agent/src/agent.rs

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 //! # agent
+//!
 //! The agent is a set of 3 actors:
 //! - [sender_accounts_manager::SenderAccountsManager]
 //! - [sender_account::SenderAccount]
@@ -22,7 +23,7 @@
 //! [sender_allocation::SenderAllocation] receives notifications from the spawned task and then
 //! it updates its state an notifies its parent actor.
 //!
-//! Once [sender_account::SenderAccount] gets enought receipts, it uses its tracker to decide
+//! Once [sender_account::SenderAccount] gets enough receipts, it uses its tracker to decide
 //! what is the allocation with the most amount of fees and send a message to trigger a RavRequest.
 //!
 //! When the allocation is closed by the indexer, [sender_allocation::SenderAllocation] is

crates/tap-agent/src/agent/sender_accounts_manager.rs

@@ -87,7 +87,7 @@ impl Display for AllocationId {
 #[derive(Debug)]
 pub enum SenderAccountsManagerMessage {
     /// Spawn and Stop [SenderAccount]s that were added or removed
-    /// in comparision with it current state and updates the state
+    /// in comparison with it current state and updates the state
     UpdateSenderAccounts(HashSet<Address>),
 }
 

crates/tap-agent/src/backoff.rs

@@ -2,8 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 //! # backoff
+//!
 //! This module is used to provide a helper that keep tracks of exponential backoff information in a
-//! non-blocking way. This is important since Actors process one message at a time, and an sleep in
+//! non-blocking way. This is important since Actors process one message at a time, and a sleep in
 //! the middle would affect performance.
 //!
 //! This way we just mark something as "in backoff" and just check that information before sending
@@ -21,14 +22,14 @@ pub struct BackoffInfo {
 }
 
 impl BackoffInfo {
-    /// Callback represinging that a request succeed
+    /// Callback representing a successful request
     ///
     /// This resets the failed_count
     pub fn ok(&mut self) {
         self.failed_count = 0;
     }
 
-    /// Callback represinging that a request failed
+    /// Callback representing a failed request
     ///
     /// This sets the backoff time to max(100ms * 2 ^ retries, 60s)
     pub fn fail(&mut self) {
@@ -39,7 +40,7 @@ impl BackoffInfo {
         self.failed_count += 1;
     }
 
-    /// Returns if is in backoff
+    /// Returns if backoff is in process
     pub fn in_backoff(&self) -> bool {
         let now = Instant::now();
         now < self.failed_backoff_time

crates/tap-agent/src/lib.rs

@@ -4,10 +4,11 @@
 #![warn(missing_docs)] // Warns if any public item lacks documentation
 
 //! # Tap-Agent
+//!
 //! This software is used to monitor receipts inserted in the database
 //! and to keep track of all the values across different allocations.
 //!
-//! It's main goal is that the value never goes below the balance available
+//! Its main goal is that the value never goes below the balance available
 //! in the escrow account for a given sender.
 
 use indexer_config::Config;

crates/tap-agent/src/tracker.rs

@@ -57,6 +57,6 @@ pub trait AllocationStats<U> {
     ///
     /// Pending fees are usually fees that not eligible to trigger a RAV,
     /// for example, you don't want to trigger a Rav Request if your only allocation is currently
-    /// requesting, so this should return a value that don't contains that allocation
+    /// requesting, so this should return a value that doesn't contain that allocation
     fn get_valid_fee(&mut self) -> u128;
 }

crates/tap-agent/src/tracker/sender_fee_stats.rs

@@ -16,8 +16,8 @@ pub struct SenderFeeStats {
     pub(super) total_fee: u128,
     /// counter of receipts
     pub(super) count: u64,
-    /// there are some allocations that we don't want it to be
-    /// heaviest allocation, because they are already marked for finalization,
+    /// there are some allocations that we don't want to be the
+    /// heaviest allocation. This is because they are already marked for finalization,
     /// and thus requesting RAVs on their own in their `post_stop` routine.
     pub(super) blocked: bool,
     /// amount of fees that are currently being requested