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

chore: fix some comments #994

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/contribute/bugreports.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Bug reports are critical to the rapid development of the Prysm client. In order

## Checking if your issue exists

Duplicate tickets are a hinderance to the development process and, as such, it is crucial to first check through Prysm's existing issues to see if what you are experiencing has already been indexed.
Duplicate tickets are a hindrance to the development process and, as such, it is crucial to first check through Prysm's existing issues to see if what you are experiencing has already been indexed.

To do so, head over to the [issue page](https://github.com/prysmaticlabs/prysm/issues) and enter some related keywords into the search bar. This may include a sample from the output or specific components it affects. If this is unsuccessful, check the [issue labels index](https://github.com/prysmaticlabs/prysm/labels) for related categories and review the tickets within.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/contribute/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Please define the following environment variable when running tests:

CGO_CFLAGS="-O2 -D__BLST_PORTABLE__"

It is particulary useful when running tests / debug in your IDE without using bazel.
It is particularly useful when running tests / debug in your IDE without using bazel.

See the [next section](#building-and-testing-prysm-with-bazel) for instructions on testing with prysm.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/devtools/net-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A high level overview of the proposed design. This states the components of the

**Transport**

For network transport we must be able to support TCP connections (UDP not a requirement). We have to be able to manage inbound and outbound tcp connections. Although not a requirement for mainnet, for interoperability all clients will have to be able to support an IPv4 endpoint. Any listening endpoints must be publically communicable, so Circuit Relays, AutoNat, etc are not applicable.
For network transport we must be able to support TCP connections (UDP not a requirement). We have to be able to manage inbound and outbound tcp connections. Although not a requirement for mainnet, for interoperability all clients will have to be able to support an IPv4 endpoint. Any listening endpoints must be publicly communicable, so Circuit Relays, AutoNat, etc are not applicable.

**Current Status in Prysm**

Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-prysm-works/database-backend-boltdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ After testing and benchmarking all three options, Bolt was decided upon as the b

## BoltDB functionality

All database related logic is contained in the `db/` directory of the Prysm repository. Given that BoltDB is a [key-value store](/docs/terminology#key-value-store) backend, 'buckets' \(akin to tables in relational databases\) are required for data storage. Blocks, transactions, state, proposals and attestations are are all defined in these buckets, in what is known as 'bucket data'.
All database related logic is contained in the `db/` directory of the Prysm repository. Given that BoltDB is a [key-value store](/docs/terminology#key-value-store) backend, 'buckets' \(akin to tables in relational databases\) are required for data storage. Blocks, transactions, state, proposals and attestations are all defined in these buckets, in what is known as 'bucket data'.

### Example: bucket creation

Expand Down
2 changes: 1 addition & 1 deletion website/docs/install/install-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ docker run -it -v %LOCALAPPDATA%\Eth2:/data -p 4000:4000 -p 13000:13000 -p 12000
:::info
`http-host` and `http-port` have replaced `--grpc-gateway-host` and `--grpc-gateway-port` respectively.
:::
This tells your Docker container to to "listen" for connections from outside of your container, allowing you (and other services) to reach your RPC endpoint(s). See [Configure ports and firewalls](../prysm-usage/p2p-host-ip.md) for more information.
This tells your Docker container to "listen" for connections from outside of your container, allowing you (and other services) to reach your RPC endpoint(s). See [Configure ports and firewalls](../prysm-usage/p2p-host-ip.md) for more information.