Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and punctuation issues across multiple files #854

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Dimitrolito
Copy link

This pull request addresses minor typos, punctuation errors, and formatting issues in several documentation files. The changes improve readability and ensure grammatical consistency. Below are the key fixes applied:

  • Corrected the usage of "up to date" to "up-to-date" in relevant contexts.
  • Fixed hyphenation in "step-by-step" and "full-blown."
  • Added missing commas and hyphens, such as in dates ("October 8, 2024") and compound adjectives ("7-day challenge period").
  • Adjusted phrasing for better clarity, such as changing "brand new" to "brand-new" and improving flow in sentences related to the use of fraud proofs and liquidity providers.

These edits enhance the overall clarity and consistency of the documentation.

Copy link

vercel bot commented Nov 25, 2024

@Dimitrolito is attempting to deploy a commit to the Infura Web Team on Vercel.

A member of the Team first needs to authorize it.

@@ -52,7 +52,7 @@ Data about the transaction and the state of the network at its time of execution
in **traces**, an output of part of the sequencer called the [trace generator](../stack/sequencer/traces-generator.md).

Traces are passed to the state manager block-by-block and then used to update the network state.
Once state is up to date, you'll see the transaction reflected and confirmed in your wallet.
Once state is up-to-date, you'll see the transaction reflected and confirmed in your wallet.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once state is up-to-date, you'll see the transaction reflected and confirmed in your wallet.
Once state is up to date, you'll see the transaction reflected and confirmed in your wallet.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing usage was correct. It should only be hyphenated when modifying a noun, which it isn't doing in this instance

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

both forms seem valid, but it seems like brand-new tends to reflect US usage better, so we'll go with that.

@@ -135,7 +135,7 @@ This is a computational entity or service that provides information or answers t

### Optimistic rollup

A rollup of transactions that use [fraud proofs](#fraud-proof) to offer increased [L2](#layer-2) transaction throughput while using the security provided by Mainnet ([L1](#layer-1)). Unlike Plasma, a similar [L2](#layer-2) solution, optimistic rollups can handle more complex transaction types – anything possible in the EVM. However, in order to release assets back on the L1, users must wait for a 7 day challenge period. Liquidity providers can help alleviate distributing L1 ETH immediately, but this relies on trust in the security of the provider, and doesn't provide a mechanism for transferring NFTs.
A rollup of transactions that use [fraud proofs](#fraud-proof) to offer increased [L2](#layer-2) transaction throughput while using the security provided by Mainnet ([L1](#layer-1)). Unlike Plasma, a similar [L2](#layer-2) solution, optimistic rollups can handle more complex transaction types – anything possible in the EVM. However, in order to release assets back on the L1, users must wait for a 7-day challenge period. Liquidity providers can help alleviate distributing L1 ETH immediately, but this relies on trust in the security of the provider, and doesn't provide a mechanism for transferring NFTs.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A rollup of transactions that use [fraud proofs](#fraud-proof) to offer increased [L2](#layer-2) transaction throughput while using the security provided by Mainnet ([L1](#layer-1)). Unlike Plasma, a similar [L2](#layer-2) solution, optimistic rollups can handle more complex transaction types – anything possible in the EVM. However, in order to release assets back on the L1, users must wait for a 7-day challenge period. Liquidity providers can help alleviate distributing L1 ETH immediately, but this relies on trust in the security of the provider, and doesn't provide a mechanism for transferring NFTs.
A rollup of transactions that use [fraud proofs](#fraud-proof) to offer increased [L2](#layer-2) transaction throughput while using the security provided by Mainnet ([L1](#layer-1)). Unlike Plasma, a similar [L2](#layer-2) solution, optimistic rollups can handle more complex transaction types – anything possible in the EVM. However, in order to release assets back on the L1, users must wait for a seven-day challenge period. Liquidity providers can help alleviate distributing L1 ETH immediately, but this relies on trust in the security of the provider, and doesn't provide a mechanism for transferring NFTs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants