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

docs: correct punctuations in README.md #7370

Merged
merged 2 commits into from
Mar 11, 2019
Merged

docs: correct punctuations in README.md #7370

merged 2 commits into from
Mar 11, 2019

Conversation

yashrajbharti
Copy link
Contributor

Corrected all grammatical errors and punctuations.

Summary

Related Issues/PRs

Corrected all typos and grammatical errors.
@googlebot
Copy link

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. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@yashrajbharti
Copy link
Contributor Author

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@yashrajbharti yashrajbharti changed the title README.md Correct punctuations README.md Mar 4, 2019
Copy link
Member

@exterkamp exterkamp left a 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).
Copy link
Member

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
Copy link
Member

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.

@patrickhulce patrickhulce changed the title Correct punctuations README.md docs: correct punctuations in README.md Mar 5, 2019
@exterkamp exterkamp added docs and removed docs labels Mar 6, 2019
@paulirish
Copy link
Member

addressed feedback.

in a separate PR i'll rewrite that throttling paragraph since it's incorrect now.

@brendankenny brendankenny merged commit 2bd7a95 into GoogleChrome:master Mar 11, 2019
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.

5 participants