docs: fix accidental ordered-list rendering in develop-with-containers - #25974
Open
consiliorum wants to merge 1 commit into
Open
docs: fix accidental ordered-list rendering in develop-with-containers#25974consiliorum wants to merge 1 commit into
consiliorum wants to merge 1 commit into
Conversation
'1)' and '2)' were meant as an inline parenthetical enumeration within one sentence. A prior edit addressing docker#24394 reflowed this paragraph across multiple lines, which put '1)' (originally on the same line as the rest of the sentence) at the start of a line - and per the CommonMark spec, both '.' and ')' after a digit at the start of a line are valid ordered-list markers. This caused '1)' to render as an actual list item while '2)', still mid-line, stayed as plain text - an inconsistent, unintended result. Restored the sentence to a single paragraph, matching the pre-docker#24394 formatting, keeping the additional clarifying text that docker#24394 added.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
Bot
added
the
area/get-started
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
1 participant
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.
While reading this page, I noticed "1)" renders as a bullet point while "2)" stays inline mid-sentence:
Checked the file history with
git log -L— the original text used1)and2)symmetrically as an inline parenthetical enumeration, all on one line. A later commit addressing #24394 (clarifying where the files are located) expanded the paragraph and reflowed it across multiple lines, which put1)at the start of a line. Per the CommonMark spec, both.and)after a digit at the start of a line are valid ordered-list markers — so1)now renders as an actual list item, while2), still mid-line, stays as plain text. Inconsistent and presumably unintended.This PR restores the sentence to a single paragraph (matching the pre-#24394 formatting), keeping the additional clarifying text that #24394 added. Verified in a local Markdown preview that it now renders as plain prose with no stray list item.