[TASK] End the sentences that introduce a code block with a colon - #588
Merged
Merged
Conversation
"Look up the commit ID with", "continue the cherry-pick with" and "you should
ideally see something like this" each run into the block below them, so the
page shows a sentence that stops. A colon finishes them.
The first of those blocks also had its content on the line directly under the
directive, without the blank line that separates a directive from its body.
render-guides accepts it and the published page shows the block correctly, but
it was the only place in this manual written that way.
Two paragraphs in the migration how-to deliberately keep no colon: there the
sentence resumes after the block ("... by using / make docs / instead of
typing a long docker run ... command").
Assisted-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Lina Wolf
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.
"Look up the commit ID with", "continue the cherry-pick with" and "you should
ideally see something like this" each run into the block below them, so the
page shows a sentence that stops. A colon finishes them.
The first of those blocks also had its content on the line directly under the
directive, without the blank line that separates a directive from its body.
render-guides accepts it and the published page shows the block correctly, but
it was the only place in this manual written that way.
Two paragraphs in the migration how-to deliberately keep no colon: there the
sentence resumes after the block ("... by using / make docs / instead of
typing a long docker run ... command").
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf