Skip to content

Commit b27af41

Browse files
authored
Merge pull request #9767 from ethereum/style-guide-patches
Style guide patch
2 parents b9fd160 + 4490e9e commit b27af41

File tree

10 files changed

+15
-15
lines changed

10 files changed

+15
-15
lines changed

src/content/community/research/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ To onboard more people onto Ethereum, the ecosystem must improve the UX/UI. This
216216

217217
### Economics {#economics}
218218

219-
Economics research in Ethereum broadly follows two approaches: validate the security of mechanisms relying on economic incentives ("microeconomics") and analyse the flows of value between protocols, applications and users ("macroeconomics"). There are complex crypto-economic factors relating to Ethereum's native asset (ether) and the tokens built on top of it (for example NFTs and ERC20 tokens).
219+
Economics research in Ethereum broadly follows two approaches: validate the security of mechanisms relying on economic incentives ("microeconomics") and analyze the flows of value between protocols, applications and users ("macroeconomics"). There are complex crypto-economic factors relating to Ethereum's native asset (ether) and the tokens built on top of it (for example NFTs and ERC20 tokens).
220220

221221
#### Background reading {#background-reading-9}
222222

@@ -248,7 +248,7 @@ Blockspace markets govern the inclusion of end-user transactions, either directl
248248

249249
### Proof-of-stake incentives {#proof-of-stake-incentives}
250250

251-
Validators use Ethereum's native asset (ether) as collateral against dishonest behaviour. The cryptoeconomics of this determines the security of the network. Sophisticated validators may be able to exploit the nuances of the incentive layer to launch explicit attacks.
251+
Validators use Ethereum's native asset (ether) as collateral against dishonest behavior. The cryptoeconomics of this determines the security of the network. Sophisticated validators may be able to exploit the nuances of the incentive layer to launch explicit attacks.
252252

253253
#### Background reading {#background-reading-11}
254254

src/content/contributing/design-principles/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Ethereum is a global, decentralized project and our audience reflects this. The
5151
- **Straightforward:** The site should be simple and unambiguous. Copy shouldn't use language that may be misinterpreted or lost in translation.
5252
- **Ethereum is multi-faceted:** Ethereum is a project, a codebase, a community, and a vision. Ethereum is valuable to different people for different reasons, and there are many ways to be involved.
5353

54-
Writing systems • Use of colour • Visual Direction • Content
54+
Writing systems • Use of color • Visual Direction • Content
5555

5656
### 3. A Good Story {#3-a-good-story}
5757

src/content/developers/docs/consensus-mechanisms/pos/faqs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ lang: en
66

77
## What is proof-of-stake {#what-is-proof-of-stake}
88

9-
Proof-of-stake is a class of algorithm that can provide security to blockchains by ensuring that assets of value are lost by attackers who act dishonestly. Proof-of-stake systems require a set of validators to make some asset available that can be destroyed if the validator engages in some provably dishonest behaviour. Ethereum uses a proof-of-stake mechanism to secure the blockchain.
9+
Proof-of-stake is a class of algorithm that can provide security to blockchains by ensuring that assets of value are lost by attackers who act dishonestly. Proof-of-stake systems require a set of validators to make some asset available that can be destroyed if the validator engages in some provably dishonest behavior. Ethereum uses a proof-of-stake mechanism to secure the blockchain.
1010

1111
## How does proof-of-stake compare to proof-of-work? {#comparison-to-proof-of-work}
1212

@@ -93,7 +93,7 @@ Social slashing is the ability of the community to coordinate a fork of the bloc
9393

9494
## Will I get slashed? {#will-i-get-slashed}
9595

96-
As a validator, it is very difficult to get slashed unless you deliberately engage in malicious behaviour. Slashing is only implemented in very specific scenarios where validators propose multiple blocks for the same slot or contradict themselves with their attestations - these are very unlikely to arise accidentally.
96+
As a validator, it is very difficult to get slashed unless you deliberately engage in malicious behavior. Slashing is only implemented in very specific scenarios where validators propose multiple blocks for the same slot or contradict themselves with their attestations - these are very unlikely to arise accidentally.
9797

9898
[More on slashing conditions](https://eth2book.info/altair/part2/incentives/slashing)
9999

src/content/developers/docs/networking-layer/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Once peers are connected, and an RLPx session has been started, the wire protoco
7777

7878
#### les (light ethereum subprotocol) {#les}
7979

80-
This is a minimal protocol for syncing light clients. Traditionally this protocol has rarely been used because full nodes are required to serve data to light clients without being incentivized. The default behaviour of execution clients is not to serve light client data over les. More information is available in the les [spec](https://github.com/ethereum/devp2p/blob/master/caps/les.md).
80+
This is a minimal protocol for syncing light clients. Traditionally this protocol has rarely been used because full nodes are required to serve data to light clients without being incentivized. The default behavior of execution clients is not to serve light client data over les. More information is available in the les [spec](https://github.com/ethereum/devp2p/blob/master/caps/les.md).
8181

8282
#### Snap {#snap}
8383

src/content/developers/docs/standards/tokens/erc-721/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ recent_births = [get_event_data(w3.codec, ck_extra_events_abi[1], log)["args"] f
246246
creatures we call CryptoKitties.
247247
- [Sorare](https://sorare.com/) is a global fantasy football game where you can collect limited editions collectibles,
248248
manage your teams and compete to earn prizes.
249-
- [The Ethereum Name Service (ENS)](https://ens.domains/) offers a secure & decentralised way to address resources both
249+
- [The Ethereum Name Service (ENS)](https://ens.domains/) offers a secure & decentralized way to address resources both
250250
on and off the blockchain using simple, human-readable names.
251251
- [POAP](https://poap.xyz) delivers free NFTs to people who attend events or complete specific actions. POAPs are free to create and distribute.
252252
- [Unstoppable Domains](https://unstoppabledomains.com/) is a San Francisco-based company building domains on

src/content/developers/docs/storage/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ IPFS is a distributed system for storing and accessing files, websites, applicat
6262
- [4EVERLAND](https://www.4everland.org/)_(IPFS pinning service)_
6363
- [Filebase](https://filebase.com) _(IPFS Pinning Service)_
6464

65-
SWARM is a decentralised data storage and distribution technology with a storage incentive system and a storage rent price oracle.
65+
SWARM is a decentralized data storage and distribution technology with a storage incentive system and a storage rent price oracle.
6666

6767
## Data retention {#data-retention}
6868

@@ -186,7 +186,7 @@ Proof-of-stake based:
186186
- [Documentation](https://docs.filebase.com/)
187187
- [GitHub](https://github.com/filebase)
188188

189-
**4EVERLAND - _A Web 3.0 cloud computing platform that integrates storage, compute and networking core capabilities, is S3 compatible and provides synchronous data storage on decentralised storage networks such as IPFS and Arweave._**
189+
**4EVERLAND - _A Web 3.0 cloud computing platform that integrates storage, compute and networking core capabilities, is S3 compatible and provides synchronous data storage on decentralized storage networks such as IPFS and Arweave._**
190190

191191
- [4everland.org](https://www.4everland.org/)
192192
- [Documentation](https://docs.4everland.org/)

src/content/developers/docs/transactions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Ethereum originally had one format for transactions. Each transaction contained
193193

194194
Ethereum has evolved to support multiple types of transactions to allow for new features such as access lists and [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559) to be implemented without affecting legacy transaction formats.
195195

196-
[EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) is what allows for this behaviour. Transactions are interpreted as:
196+
[EIP-2718](https://eips.ethereum.org/EIPS/eip-2718) is what allows for this behavior. Transactions are interpreted as:
197197

198198
`TransactionType || TransactionPayload`
199199

src/content/developers/tutorials/how-to-mock-solidity-contracts-for-testing/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ You will get one of the following error messages:
8888

8989
Since we are using the new 0.6 Solidity version, we have to add the `virtual` keyword for functions that can be overridden and override for the overriding function. So let us add those to both `isPublic` functions.
9090

91-
Now in your unit tests, you can use `PrivateERC20Mock` instead. When you want to test the behaviour during the private usage time, use `setIsPublic(false)` and likewise `setIsPublic(true)` for testing the public usage time. Of course in our example, we could just use [time helpers](https://docs.openzeppelin.com/test-helpers/0.5/api#increase) to change the times accordingly as well. But the idea of mocking should be clear now and you can imagine scenarios where it is not as easy as simply advancing the time.
91+
Now in your unit tests, you can use `PrivateERC20Mock` instead. When you want to test the behavior during the private usage time, use `setIsPublic(false)` and likewise `setIsPublic(true)` for testing the public usage time. Of course in our example, we could just use [time helpers](https://docs.openzeppelin.com/test-helpers/0.5/api#increase) to change the times accordingly as well. But the idea of mocking should be clear now and you can imagine scenarios where it is not as easy as simply advancing the time.
9292

9393
## Mocking many contracts {#mocking-many-contracts}
9494

95-
It can become messy if you have to create another contract for every single mock. If this bothers you, you can take a look at the [MockContract](https://github.com/gnosis/mock-contract) library. It allows you to override and change behaviours of contracts on-the-fly. However, it works only for mocking calls to another contract, so it would not work for our example.
95+
It can become messy if you have to create another contract for every single mock. If this bothers you, you can take a look at the [MockContract](https://github.com/gnosis/mock-contract) library. It allows you to override and change behaviors of contracts on-the-fly. However, it works only for mocking calls to another contract, so it would not work for our example.
9696

9797
## Mocking can be even more powerful {#mocking-can-be-even-more-powerful}
9898

src/content/nft/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Here's how an internet of NFTs compared to the internet most of us use today loo
4141
| NFTs are compatible with anything built using Ethereum. An NFT ticket for an event can be traded on every Ethereum marketplace, for an entirely different NFT. You could trade a piece of art for a ticket! | Companies with digital items must build their own infrastructure. For example an app that issues digital tickets for events would have to build their own ticket exchange. |
4242
| Content creators can sell their work anywhere and can access a global market. | Creators rely on the infrastructure and distribution of the platforms they use. These are often subject to terms of use and geographical restrictions. |
4343
| Creators can retain ownership rights over their own work, and claim resale royalties directly. | Platforms, such as music streaming services, retain the majority of profits from sales. |
44-
| Items can be used in surprising ways. For example, you can use digital artwork as collateral in a decentralised loan. | |
44+
| Items can be used in surprising ways. For example, you can use digital artwork as collateral in a decentralized loan. | |
4545

4646
### NFT examples {#nft-examples}
4747

@@ -258,7 +258,7 @@ This is still experimental but you can learn more about fractional NFT ownership
258258
- [NIFTEX](https://landing.niftex.com/)
259259
- [NFTX](https://gallery.nftx.org/)
260260

261-
In theory, this would unlock the possibility to do things like own a piece of a Picasso. You would become a shareholder in a Picasso NFT, meaning you would have a say in things like revenue sharing. It's very likely that one day soon owning a fraction of an NFT will enter you into a decentralised autonomous organisation (DAO) for managing that asset.
261+
In theory, this would unlock the possibility to do things like own a piece of a Picasso. You would become a shareholder in a Picasso NFT, meaning you would have a say in things like revenue sharing. It's very likely that one day soon owning a fraction of an NFT will enter you into a decentralized autonomous organisation (DAO) for managing that asset.
262262

263263
These are Ethereum-powered organisations that allow strangers, like global shareholders of an asset, to coordinate securely without necessarily having to trust the other people. That's because not a single penny can be spent without group approval.
264264

src/content/staking/pools/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Pooled or delegated staking is not natively supported by the Ethereum protocol,
3737

3838
Each pool and the tools or smart contracts they use have been built out by different teams, and each comes with benefits and risks. Pools enable users to swap their ETH for a token representing staked ETH. The token is known as a "liquid staking derivative"; this is useful because it allows users to swap any amount of ETH to an equivalent amount of a yield-bearing token that generates a return from the staking rewards applied to the underlying staked ETH (and vice versa) on decentralized exchanges even though the actual ETH stays staked on the Beacon Chain. This means swaps back and forth from a yield-bearing staked-ETH product and "raw ETH" is quick, easy and not only available in multiples of 32 ETH.
3939

40-
However, these liquid staking derivatives tend to create cartel-like behaviours where a large amount of staked ETH ends up under the control of a few centralized organizations rather than spread across many independent individuals. This creates conditions for censorship or value extraction. The gold standard for staking should always be individuals running validators on their own hardware whenever possible.
40+
However, these liquid staking derivatives tend to create cartel-like behaviors where a large amount of staked ETH ends up under the control of a few centralized organizations rather than spread across many independent individuals. This creates conditions for censorship or value extraction. The gold standard for staking should always be individuals running validators on their own hardware whenever possible.
4141

4242
[More on risks of staking tokens](https://notes.ethereum.org/@djrtwo/risks-of-lsd).
4343

0 commit comments

Comments
 (0)