Skip to content

Update networks doc to avoid passive voice & reduce word count #6619

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 9, 2022
Merged

Update networks doc to avoid passive voice & reduce word count #6619

merged 3 commits into from
Jun 9, 2022

Conversation

setgree
Copy link
Contributor

@setgree setgree commented Jun 9, 2022

  • The lead sentence in this page should define networks rather than explaining something about how they work, so I switched the first and second sentences around
  • Some passive voice, e.g. "Agreement on transactions...is decided by a consensus of peers," which I rearranged to put the actors first
  • some overlong, repetitive sentences that I condensed

Further suggestions

  • The page has a few more instances of passive voice whose intent I wasn't clear enough about to feel confident editing, e.g. "it's useful to know" -- perhaps a real expert can take a second look 😃
  • Perhaps the deprecated networks can be moved to the bottom of the page under a header 'Deprecated networks?' I wasn't sure enough about this to make the change

Thanks in advance!

Description

Related Issue

@setgree
Update networks doc to avoid passive voice & reduce word count
e17aff7 
* The lead sentence in this page should define networks rather than explaining something about how they work, so I switched the first and second sentences around
* Some passive voice, e.g. "Agreement on transactions...is decided by a consensus of peers," which I rearranged to put the actors first 
* some overlong, repetitive sentences that I condensed

### Further suggestions
* The page has a few more instances of passive voice whose intent I wasn't clear enough about to feel confident editing, e.g. "it's useful to know" -- perhaps a real expert can take a second look 😃 
* Perhaps the deprecated networks can be moved to the bottom of the page under a header 'Deprecated networks?' I wasn't sure enough about this to make the change

Thanks in advance!
@github-actions github-actions bot added content 🖋️ This involves copy additions or edits review needed 👀 labels Jun 9, 2022
minimalsm
minimalsm approved these changes Jun 9, 2022
View reviewed changes
Copy link
Contributor

@minimalsm minimalsm left a comment

Choose a reason for hiding this comment

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

Thanks for the improvements @setgree ❤️

@minimalsm minimalsm merged commit 2d2ae12 into ethereum:dev Jun 9, 2022
@minimalsm
Copy link
Contributor

The page has a few more instances of passive voice whose intent I wasn't clear enough about to feel confident editing, e.g. "it's useful to know" -- perhaps a real expert can take a second look 😃

I think the tone of that sentence is fine. What would you suggest?

Perhaps the deprecated networks can be moved to the bottom of the page under a header 'Deprecated networks?' I wasn't sure enough about this to make the change

Ideally, yes. However, on Ethereum things being deprecated and things being unused are two different stories 😅 e.g. Rinkeby is still the most widely used testnet for development purposes right now. It isn't ideal, but keeping them together (for the list of faucets) would be my preference for now. Hopefully we can remove them soon :-)

@setgree
Copy link
Contributor Author

setgree commented Jun 9, 2022

👋 thanks for the quick turnaround! I observe that you and I part ways on the question of sentence fragments, but I happily defer. (A matter of taste! 😃)

  • RE: "it's useful to know" -- I'm not sure TBH, perhaps passive voice is the right thing here
  • RE: deprecated vs. out of use -- totally see your point, I lacked that context

Until next time,

@minimalsm minimalsm mentioned this pull request Jun 13, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@minimalsm minimalsm minimalsm approved these changes

@samajammin samajammin Awaiting requested review from samajammin

@wackerow wackerow Awaiting requested review from wackerow wackerow is a code owner

@corwintines corwintines Awaiting requested review from corwintines corwintines is a code owner

@pettinarip pettinarip Awaiting requested review from pettinarip pettinarip is a code owner

Assignees
No one assigned
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@setgree @minimalsm