Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

GuyHoozdis
Copy link
Contributor

Purpose

While reading the configuration page in the docs, I was reading the build_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

  1. Notice that the latest version of the docs demonstrates the corrupted table (or at HEAD on origin/main of the PSR repo).
  2. Clone or sync your local copy of the code with this PR or the forked repo.
  3. Build the documentation locally.
  4. Open the docs you just compiled, navigate to the configuration page and then down to the build_command section.
    Verify that the table is now rendered correctly.

@codejedi365 codejedi365 merged commit a5eff0b into python-semantic-release:master Aug 1, 2024
6 of 7 checks passed
@codejedi365
Copy link
Contributor

Good catch, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants