Fix reST nesting in the Configuration docstring (unbreaks the docs build on main) - #126
Merged
Merged
Conversation
The defaults key list from roed314#119 and the warnings-as-errors docs build from roed314#122 first met when both merged: a nested bullet list needs blank lines around it in reST, so the docs job (and the Read the Docs build) failed on main with 'Unexpected indentation'. Two blank lines fix it, and the key list now renders as an actual nested list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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.
main's docs job and the first Read the Docs build (33701778) fail with two warnings in
psycodict.config.Configuration: the nested key list underdefaults(rewritten in #119) has no blank lines around it, which reST parses as stray indentation. #119 and #122 were each green on their own CI — the new docstring and the warnings-as-errors build first met on main, which is exactly the regression class the-Wgate exists to catch.Two blank lines fix it; the key list now renders as a real nested list under the
defaultsbullet. Verified locally at main: reproduced the same two warnings, zero after the fix,ruff check .clean. Read the Docs rebuildslatestautomatically once this merges.🤖 Generated with Claude Code