style(endpoint-share): format share-url example - #910
Merged
Conversation
`prettier . --check` has failed on this file since ba8e19a, and because `lint:prettier` runs before `lint:js` and `lint:css`, the linter step fails on every pull request before the tests are reached. Formatting only, no change to the documented markup.
Collaborator
|
We should stick to one line and avoid the non-self-closing tag. Prettier’s HTML linting is a bit suspect, and we disable it in Let’s use |
paulrobertlloyd
pushed a commit
that referenced
this pull request
Aug 24, 2026
#910 fixed the failing Prettier check by accepting what Prettier wanted, which split the `<link>` over three lines and made it self-closing. The trailing slash has no meaning on a void element and reads as though it does, so the original one-line form is the better documentation. `.prettierignore` already excludes `*.html`, but this markup is a fenced block inside a Markdown file, which that pattern does not match — so it was formatted as embedded code rather than skipped. A `<!-- prettier-ignore -->` comment excludes just this block and leaves the rest of the file checked. `prettier --check` passes across tracked files.
paulrobertlloyd
added
code quality
Collaborator
|
Oops! Sorry. Is a better PR check config needed to catch this? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
prettier . --checkhas failed onpackages/endpoint-share/README.mdsince ba8e19a, when therel="share-url"example was added.Because
lintrunslint:prettier && lint:js && lint:css, that failure ends the linter step beforelint:jsandlint:cssrun, and theRun testsstep is skipped — so every pull request currently goes red without its tests being exercised. Spotted while opening #909, whose tests were skipped for this reason.This is
prettier --writeoutput and nothing else — formatting only, no change to the documented markup.Verified on this branch:
npm run lintexits 0 (prettier clean, eslint 0 errors, stylelint clean).If you'd rather keep the example on one line, a
<!-- prettier-ignore -->above the fence would do it instead — happy to switch.