Skip to content

Commit

Permalink
penumbra: fix typos (#4977)
Browse files Browse the repository at this point in the history
This pull request addresses several grammar issues across multiple files
in the repository. The changes include corrections such as replacing "a"
with "an" where appropriate (e.g., before words starting with vowel
sounds) and fixing typos or inconsistencies in documentation and
comments.

## Files Updated

1. **`chandelier.rs`**
   - Fixed: "an superfluous" → "a superfluous."
2. **`path_search.rs`**
   - Fixed: "a inclusive" → "an inclusive."
3. **`r1cs.rs`**
   - Fixed: "a individual" → "an individual."
4. **`addresses.md`**
   - Fixed: "a address" → "an address."
5. **`system_mapping.md`**
   - Fixed: "an bound" → "a bound."

## Checklist Before Review

- [x] Updated grammar errors in all relevant files.
- [x] Verified that no other grammatical inconsistencies remain in the
affected areas.
- [x] Added guiding comments for reviewers to verify changes.

## Testing Notes

No code changes affecting functionality were made, so no unit tests were
added. These changes only affect comments and documentation, ensuring
clarity and accuracy.

---------

Signed-off-by: Marco <wudmytrotest200@gmail.com>
  • Loading branch information
Marcofann authored Jan 11, 2025
1 parent fe075d4 commit c90fa23
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion crates/core/component/dex/src/component/chandelier.rs
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ pub trait Chandelier: StateWrite {
#[tracing::instrument(level = "debug", skip(self))]
async fn record_swap_execution(&mut self, swap: &SwapExecution) {
// Don't record a swap execution if the output amount was zero.
// This is not an superfluous check, as the swap execution could really
// This is not a superfluous check, as the swap execution could really
// have zero output e.g. in the case of a dust swap.
if swap.output.amount == 0u32.into() || swap.input.amount == 0u32.into() {
tracing::debug!(?swap, "skipping swap execution");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ pub trait PathSearch: StateRead + Clone + 'static {
// Note: previously, this branch was a load-bearing termination condition, primarily
// exercised by the arbitrage logic. However, during the course of testnet 53, we
// encountered two bugs that caused this predicate to not be exercised:
// 1. We treated the price limit as a inclusive bound, rather than an exclusive bound.
// 1. We treated the price limit as an inclusive bound, rather than an exclusive bound.
// 2. We relied on an estimate of the end-to-end path price which was lossy (`path.price`).
// The latter is an inherent information limitation, so we now have a redundant check in
// `route_and_fill` which uses the exact price of the route.
Expand Down
2 changes: 1 addition & 1 deletion crates/crypto/tct/src/r1cs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ impl ToConstraintField<Fq> for Position {
// The variable created in AllocVar<Position, Fq> is a UInt64, which is a
// Vec of 64 Boolean<Fq> constraints. To construct the corresponding
// public input, we need to convert the u64 into 64 bits, and then
// convert each bit into a individual Fq element.
// convert each bit into an individual Fq element.
let mut field_elements = Vec::<Fq>::new();
let value: u64 = u64::from(*self);
for i in 0..64 {
Expand Down
2 changes: 1 addition & 1 deletion docs/protocol/src/addresses_keys/addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Each payment address has three components:
* the *transmission key* $\mathsf{pk_d}$, a `decaf377` element;
* the *clue key* $\mathsf{ck_d}$, a `decaf377` element.

The diversifier is derived from a address index as described above. The
The diversifier is derived from an address index as described above. The
diversifier $d_0$ with index $0$ is the *default diversifier*, and corresponds
to the *default payment address*.

Expand Down
2 changes: 1 addition & 1 deletion docs/protocol/src/crypto/fmd/system_mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ A consensus rule verifies that clues in transactions have been generated using
the appropriate precision, within a grace period of 10 blocks[^1]. Transactions
with clues generated using the incorrect precision are rejected by the network.

[^1]: This imposes an bound on the latency of signing workflows.
[^1]: This imposes a bound on the latency of signing workflows.

0 comments on commit c90fa23

Please sign in to comment.