Repository navigation
Fix extra spaces in the generated configuration docs - #6148
Open
deepdishgary wants to merge 1 commit into
Open
deepdishgary wants to merge 1 commit into
deepdishgary wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
The configuration reference pages under
site/content/in-dev/unreleased/configuration/config-sections/have extra spaces wherever the source Javadoc wraps to a new line. The extra spaces came up in the reviews of #5779 and #5972.MarkdownFormatterturns each line break into a space but keeps the next line's indentation, so every wrapped line gives two or more spaces, for exampleends it earlyin a list item.{@code}tag that wraps to the next line has a body that starts with a line break. The formatter treated that as a word break, so it put a space before or after the code span, for example`prod` .and( `x`).This change collapses a line break and the indentation around it into one space. It also stops adding a separator around a code span because of whitespace inside the tag.
TestMarkdownFormattercovers both cases. The expected strings inTestDocGenTooland the regenerated pages differ only in whitespace (git diff -wshows no change). The regenerated pages include the Cloudflare R2 page from #5972.Checklist
changelog.d/(if needed, seechangelog.d/README.md)site/content/in-dev/unreleased(if needed)