style(endpoint-share): keep the share-url example on one line - #914
Merged
Conversation
#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
documentation
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
2 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.
Follows @paulrobertlloyd's comment on #910.
#910 cleared the failing Prettier check by accepting what Prettier wanted, which split the
<link>over three lines and made it self-closing. As noted there, that is the wrong way round: a void element needs no trailing slash, and having one suggests a meaning it does not have.This restores the original one-line example and adds
<!-- prettier-ignore -->above the block instead.On why Prettier caught it at all:
.prettierignoreexcludes*.html, but this is a fenced ```html block inside a Markdown file, so that pattern never applied and Prettier formatted it as embedded code. The ignore comment scopes the exclusion to this one block, leaving the rest of the file checked.Verified with
git ls-files -z | xargs -0 npx prettier --check --ignore-unknown— all tracked files pass.