Repository navigation
docs: update deprecated link to shared flags - #15722
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
adamraine
left a comment
There was a problem hiding this comment.
The exact line numbers of this can change from commit to commit so it's more stable to use a permalink (i.e. what the old link was). That being said, you do highlight a problem with our docs that they can become stale pretty easily.
I'm not aware of a linking method that gives us the best of both worlds so for now maybe we just use this link:
lighthouse/types/lhr/settings.d.ts
Line 55 in 30e617e
how about this link: https://github.com/GoogleChrome/lighthouse/blob/main/types/lhr/settings.d.ts#:~:text=interface%20SharedFlagsSettings |
Perfect! Exactly what I was looking for! |
Summary
In the file https://github.com/GoogleChrome/lighthouse/blob/main/docs/readme.md#differences-from-cli-flags is a link in the section "Differences from CLI flags" which points to a commit from over 6 years ago.
The linked information is outdated.
I understand that the commit was included in the link because then the highlighting of the lines will work correctly in the future when changes are made to this file.
This solution is also only a band-aid solution, because if changes are made to the linked file, this link may have to be adapted again.
The only thing I can think of to solve this permanently would be to move the shared flags to a separate file. But I don't know where this would have to be adjusted and it might also be better as a downstream ticket.