docs: fix RST in Model.debug docstring numbered list#8281
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8281 +/- ##
==========================================
+ Coverage 88.64% 91.93% +3.29%
==========================================
Files 125 125
Lines 20302 20302
==========================================
+ Hits 17997 18665 +668
+ Misses 2305 1637 -668
🚀 New features to boost your workflow:
|
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
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.

Description
The numbered list in the
Model.debugdocstring uses a single leading space on each item, with no blank line separating it from the preceding paragraph. Sphinx/docutils reads that single-space indent as the start of an indented block and emitsWARNING: Unexpected indentation. [docutils].This was caught while working on the CausalPy repo: building the CausalPy docs surfaces this warning multiple times because the build pulls in the
pymc.Modelautodoc reference.This PR adds a blank line before the list and removes the single-space indent so docutils parses it as a proper enumerated list.
Before:
After:
Related Issue
None.
Checklist
Tests are not applicable: this is a docstring RST formatting fix, no behavior change.
Type of change