- Notifications
You must be signed in to change notification settings - Fork261
docs(build_command): Add newline to fix table rendering#996
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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 freeto 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.
Purpose
While reading theconfiguration page in the docs, I was reading thebuild_command section and noticed that the table describing the the environment variables on Windows systems was corrupted.
This PR fixes that issue so that the table is rendered correctly.
Rationale
I suspected it was likely a whitespace / newline issue, because reStructuredText depends on delineation between elements for the parser to identify those elements. When I located the source for this content I expected to find a paragraph element with the text
In addition, on windows systems these environment variables are passed:followed by the markup for a table, but no newline separating the two elements.How did you test?
I cloned the repo and built the docs to verify that the issue existed in my local version of the docs. Then I found source file and added a newline between the text and table markup. Finally, I re-built the documentation and verified that the table rendered correctly.
How to Verify
HEADonorigin/mainof the PSR repo).configurationpage and then down to thebuild_commandsection.Verify that the table is now rendered correctly.