-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
docs: correct punctuations in README.md #7370
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here (e.g. What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
I signed it! |
CLAs look good, thanks! ℹ️ Googlers: Go here for more info. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nits
readme.md
Outdated
@@ -164,7 +164,7 @@ lighthouse -GA=./gmailartifacts https://gmail.com | |||
|
|||
#### Notes on Error Reporting | |||
|
|||
The first time you run the CLI you will be prompted with a message asking you if Lighthouse can anonymously report runtime exceptions. The Lighthouse team uses this information to detect new bugs and avoid regressions. Opting out will not affect your ability to use Lighthouse in any way. [Learn more](https://github.com/GoogleChrome/lighthouse/blob/master/docs/error-reporting.md). | |||
The first time you run the CLI, you will be prompted with a message asking you if Lighthouse can anonymously report runtime exceptions. The Lighthouse team uses this information to detect new bugs and avoid regressions. Opting out will not affect your ability to use Lighthouse in any way. [Learn more](https://github.com/GoogleChrome/lighthouse/blob/master/docs/error-reporting.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree with this. I think it is fine without the comma, the beginning isn't really a distinct introductory phrase that would warrant a comma. I don't think 🤷♂️
If the first part was reworded to be more distinct I could see it.
readme.md
Outdated
@@ -324,7 +324,7 @@ Yes! Details in [Lighthouse configuration](./docs/configuration.md). | |||
### How does Lighthouse use network throttling, and how can I make it better? | |||
|
|||
Good question. Network and CPU throttling are applied by default in a Lighthouse run. The network | |||
attempts to emulate slow 4G and the CPU is slowed down 4x from your machine's default speed. If you | |||
attempts to emulate slow 4G, and the CPU is slowed down 4x from your machine's default speed. If you |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'm getting caught up on the slow 4G
wording as well. I'd add a little more context to it.
The network attempts to emulate a slow 4G network, and the CPU is slowed down 4x from
the machine's default speed.
addressed feedback. in a separate PR i'll rewrite that throttling paragraph since it's incorrect now. |
Corrected all grammatical errors and punctuations.
Summary
Related Issues/PRs