Skip to content

Commit ac3ba1e

Browse files
committed
Fix documentation typos, grammar, and correctness issues
- blockifier_reexecution/README.md: Fix "blockier" -> "blockifier", "permisionless" -> "permissionless", "dowload-files" -> "download-files", "neccessary" -> "necessary", "from the GC Bucket" -> "to the GC Bucket" - apollo_config/src/dumping.rs: Fix missing "be" in "will not included" and fix "a None sub configs, its" -> "None sub configs, their" - apollo_storage/src/lib.rs: Fix "actually" -> "actual", "non clonable" -> "non-clonable" - apollo_infra_utils/src/tracing.rs: Remove extra backtick in doc comment - mempool.md: Fix "Transaction prior" -> "Transactions prior", remove double space - swarm_trait.rs, worker_pool.rs: Fix "occured" -> "occurred" - peer_manager/mod.rs, p2p_sync server/test.rs: Fix "reciever" -> "receiver" - db_test.rs: Fix "charachter" -> "character" - blockifier_versioned_constants.rs: Fix "seperate" -> "separate" https://claude.ai/code/session_01H7Rdt1uDEga9dFsKSzPhBe
1 parent dca9a47 commit ac3ba1e

File tree

11 files changed

+19
-19
lines changed

11 files changed

+19
-19
lines changed

crates/apollo_config/src/dumping.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ fn chain_param_paths(param_paths: &[&str]) -> ParamPath {
157157
pub trait SerializeConfig {
158158
/// Conversion of a configuration to a mapping of flattened parameters to their descriptions and
159159
/// values.
160-
/// Note, in the case of a None sub configs, its elements will not included in the flatten map.
160+
/// Note, in the case of a None sub configs, its elements will not be included in the flatten map.
161161
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam>;
162162

163163
/// Serialization of a configuration into a JSON file.
@@ -196,7 +196,7 @@ pub trait SerializeConfig {
196196
/// let file_path = dir.path().join("config.json");
197197
/// ConfigExample { key: 42 }.dump_to_file(&vec![], &HashSet::new(), file_path.to_str().unwrap());
198198
/// ```
199-
/// Note, in the case of a None sub configs, its elements will not be included in the file.
199+
/// Note, in the case of None sub configs, their elements will not be included in the file.
200200
fn dump_to_file(
201201
&self,
202202
config_pointers: &ConfigPointers,

crates/apollo_infra_utils/src/tracing.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ macro_rules! trace_every_n {
137137
///
138138
/// # Arguments
139139
///
140-
/// * `$n`: Number of milliseconds (e.g., `2` for not logging a message again for `2`` milliseconds
140+
/// * `$n`: Number of milliseconds (e.g., `2` for not logging a message again for `2` milliseconds
141141
/// from when it last logged).
142142
/// * `$($arg:tt)*`: The arguments to pass to `tracing::info!`, e.g., a format string and its
143143
/// corresponding values.

crates/apollo_network/src/network_manager/swarm_trait.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ impl SwarmTrait for Swarm<mixed_behaviour::MixedBehaviour> {
111111
// TODO(shahak): Consider reporting to the subscriber broadcast failures or retrying
112112
// upon failure.
113113
warn!(
114-
"Error occured while broadcasting a message to the topic with hash \
114+
"Error occurred while broadcasting a message to the topic with hash \
115115
{topic_hash:?}: {err:?}"
116116
);
117117
}

crates/apollo_network/src/peer_manager/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ impl PeerManager {
183183
// TODO(shahak): remove this code block, since we check that peer has connection id
184184
} else {
185185
// In case we have a race condition where the connection is closed after we added to
186-
// the pending list, the reciever will get an error and will need to ask for
186+
// the pending list, the receiver will get an error and will need to ask for
187187
// re-assignment
188188
if let Some(sessions) = self.peers_pending_dial_with_sessions.get_mut(peer_id) {
189189
sessions.push(outbound_session_id);

crates/apollo_p2p_sync/src/server/test.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ async fn run_test<T, F, TQuery>(
359359
step: 1,
360360
};
361361
let query = TQuery::from(query);
362-
let (server_query_manager, _report_sender, response_reciever) =
362+
let (server_query_manager, _report_sender, response_receiver) =
363363
create_test_server_query_manager(query);
364364

365365
register_query::<T, TQuery>(
@@ -374,7 +374,7 @@ async fn run_test<T, F, TQuery>(
374374
_never = p2p_sync_server.run() => {
375375
unreachable!("Return type Never should never be constructed");
376376
},
377-
mut res = response_reciever.collect::<Vec<_>>() => {
377+
mut res = response_receiver.collect::<Vec<_>>() => {
378378
assert_eq!(DataOrFin(None), res.pop().unwrap());
379379
let filtered_res: Vec<T> = res.into_iter()
380380
.map(|data| data.0.expect("P2pSyncServer returned Fin and then returned another response"))

crates/apollo_protobuf/src/proto/p2p/proto/mempool/mempool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Our choice of using Gossipsub might change in the future if we encounter perform
1919

2020
## Transaction
2121
The object that we're passing is a [MempoolTransaction](./transaction.proto). A few notes about it:
22-
* It contains support only for V3 transactions. Transaction prior to V3 can't be a part of a mempool
23-
because they don't have the required fields to enter the fee market
22+
* It contains support only for V3 transactions. Transactions prior to V3 can't be a part of a mempool
23+
because they don't have the required fields to enter the fee market
2424
* It doesn't contain a variant for L1Handler transactions. The reason is that mempools can learn
2525
about existing L1Handler transactions by simply looking at L1
2626
* In Declare, it contains the SIERRA of the class being declared. The reason it doesn't contain the

crates/apollo_storage/src/db/db_test.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ fn open_env_with_enforce_file_exists() {
5454
let result: DbResult<(DbReader, DbWriter)> = open_env(&db_config);
5555
assert_matches!(result, Ok(_));
5656

57-
// Add some charachter to the path to make it invalid.
57+
// Add some character to the path to make it invalid.
5858
// Fourth and final call to `open_env` with path enforcement should fail because the path is
5959
// invalid.
6060
db_config.path_prefix = db_config.path_prefix.join("2");

crates/apollo_storage/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ impl StorageReader {
520520
}
521521

522522
/// A struct for starting RW transactions ([`StorageTxn`]) to the storage.
523-
/// There is a single non clonable writer instance, to make sure there is only one write transaction
523+
/// There is a single non-clonable writer instance, to make sure there is only one write transaction
524524
/// at any given moment.
525525
pub struct StorageWriter {
526526
db_writer: DbWriter,
@@ -568,7 +568,7 @@ impl Drop for MetricsHandler {
568568
}
569569

570570
/// A struct for interacting with the storage.
571-
/// The actually functionality is implemented on the transaction in multiple traits.
571+
/// The actual functionality is implemented on the transaction in multiple traits.
572572
pub struct StorageTxn<'env, Mode: TransactionKind> {
573573
txn: DbTransaction<'env, Mode>,
574574
file_handlers: FileHandlers<Mode>,

crates/blockifier/src/blockifier_versioned_constants.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ pub struct OsResources {
559559
// Mapping from every syscall to its execution resources in the OS (e.g., amount of Cairo
560560
// steps).
561561
// TODO(Arni, 14/6/2023): Update `GetBlockHash` values.
562-
// TODO(ilya): Consider moving the resources of a keccak round to a seperate dict.
562+
// TODO(ilya): Consider moving the resources of a keccak round to a separate dict.
563563
execute_syscalls: HashMap<SyscallSelector, ResourcesParams>,
564564
// Mapping from every transaction to its extra execution resources in the OS,
565565
// i.e., resources that don't count during the execution itself.

crates/blockifier/src/concurrency/worker_pool.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ impl<S: StateReader> WorkerThread<S> {
141141
panic!("Another thread panicked. Aborting.");
142142
}
143143

144-
// Making sure that the program will abort if a panic occured while halting
144+
// Making sure that the program will abort if a panic occurred while halting
145145
// the scheduler.
146146
let abort_guard = AbortIfPanic;
147147
// If a panic is not handled or the handling logic itself panics, then we

0 commit comments

Comments
 (0)