8000
Skip to content

docs(configuration): update some wording of the "extends" property - #11488

Merged
patrickhulce merged 2 commits into
GoogleChrome:masterfrom
danieleloscozzese:patch-1
Oct 5, 2020
Merged

docs(configuration): update some wording of the "extends" property#11488
patrickhulce merged 2 commits into
GoogleChrome:masterfrom
danieleloscozzese:patch-1

Conversation

@danieleloscozzese
Copy link
Copy Markdown
Contributor

From my understanding of this documentation, there is a little bit more clarity which could be offered by different wording.

Summary

This change tweaks the wording and the type definition around the extends property of the configuration to explain exactly which values are allowed.

I feel that this could be useful since I am currently investigating some issues in a deployment of lighthouse and it was not particularly clear to me if our extension was valid or not at a glance.

Related Issues/PRs

I based this on some information I saw in #7344, including a response on that issue.

There is also the (type definition)[/types/config.d.ts]. I'm trying to find the code handling this to see if any other string does have a real value or not.

From my understanding of this documentation, there is a little bit more clarity which could be offered by different wording.
@googlebot
Copy link
Copy Markdown

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 with @googlebot 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.

@patrickhulce patrickhulce left a comment
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

thanks @DanArthurGallagher!

Comment thread docs/configuration.md Outdated
@patrickhulce
Copy link
Copy Markdown
Collaborator

@DanArthurGallagher interested in signing the CLA and marking this as ready for review? :)

@danieleloscozzese
Copy link
Copy Markdown
Contributor Author

@patrickhulce I will try to get that done this evening!

Reflect the current state, not a decision.

Co-authored-by: Patrick Hulce <patrick.hulce@gmail.com>
@googlebot
Copy link
Copy Markdown

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes and removed cla: no labels Oct 5, 2020
@danieleloscozzese
danieleloscozzese marked this pull request as ready for review October 5, 2020 20:51
@danieleloscozzese
danieleloscozzese requested a review from a team as a code owner October 5, 2020 20:51
@danieleloscozzese
danieleloscozzese requested review from connorjclark and removed request for a team October 5, 2020 20:51
@danieleloscozzese danieleloscozzese changed the title docs(configuration): Update some wording docs(configuration): update some wording on extension Oct 5, 2020
@danieleloscozzese danieleloscozzese changed the title docs(configuration): update some wording on extension docs(configuration): update some wording of the "extends" property Oct 5, 2020
@patrickhulce
patrickhulce merged commit 054722a into GoogleChrome:master Oct 5, 2020
@patrickhulce
Copy link
Copy Markdown
Collaborator

thanks @DanArthurGallagher πŸŽ‰

@danieleloscozzese
danieleloscozzese deleted the patch-1 branch October 6, 2020 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

38B1 @danieleloscozzese @googlebot @patrickhulce
0