docs: fix misaligned column padding in configuration settings table#1440
Open
oniku-mogumogu wants to merge 1 commit into
Open
docs: fix misaligned column padding in configuration settings table#1440oniku-mogumogu wants to merge 1 commit into
oniku-mogumogu wants to merge 1 commit into
Conversation
The RST grid table in docs/4_configuration.rst had four data rows where the trailing pipe character (`|`) was not aligned with the column boundary defined in the separator rows (`+---+`). Affected rows and adjustments: - AXES_FAILURE_LIMIT (line 22): added 2 spaces before closing `|` - AXES_COOLOFF_TIME (line 26): removed 2 spaces before closing `|` - AXES_USE_ATTEMPT_EXPIRATION (line 28): added 54 spaces before closing `|` - AXES_LOCKOUT_CALLABLE (line 58): removed 1 space before closing `|` Docutils/Sphinx requires that `|` positions in data rows exactly match the `+` positions in separator rows; any mismatch causes the entire table to fail parsing and renders as raw text in the browser. No content changes were made — only whitespace padding was adjusted.
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
1 participant
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.
Fixes a rendering failure in the configuration settings table in
docs/4_configuration.rst.Due to misaligned column boundaries in the RST grid table, Docutils/Sphinx was failing to parse the table during the HTML build. As a result, the entire table was not rendered at all in the browser, leaving the configuration reference missing from the page.
The root cause was four data rows where the trailing pipe character (
|) was not positioned at the column boundary defined by the separator rows (+---+). Docutils requires exact alignment between|in data rows and+in separator rows; any deviation causes the entire table block to be rejected by the parser.Affected rows and adjustments:
AXES_FAILURE_LIMIT(line 22): added 2 spaces before closing|AXES_COOLOFF_TIME(line 26): removed 2 spaces before closing|AXES_USE_ATTEMPT_EXPIRATION(line 28): added 54 spaces before closing|AXES_LOCKOUT_CALLABLE(line 58): removed 1 space before closing|No content changes were made — only whitespace padding was adjusted to restore correct table parsing and proper HTML rendering.
Before submitting