Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Conversation

@GuyHoozdis
Copy link
Contributor

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 textIn 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 thelatest version of the docs demonstrates the corrupted table (or atHEAD onorigin/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 theconfiguration page and then down to thebuild_command section.
    Verify that the table is now rendered correctly.

@codejedi365codejedi365 merged commita5eff0b intopython-semantic-release:masterAug 1, 2024
@codejedi365
Copy link
Contributor

Good catch, thanks!

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@codejedi365codejedi365codejedi365 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@GuyHoozdis@codejedi365

[8]ページ先頭

©2009-2025 Movatter.jp