Commit 0500909
Fix Sphinx -W docstring failure on SyntheticDiD
CI's Sphinx HTML build (-W warnings as errors) failed on f3d5d92 with:
diff_diff/synthetic_did.py:docstring of diff_diff.synthetic_did.SyntheticDiD:63:
WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
The Conley-rejection block I added in 8ab51c4 used a custom section header
"Notes (Conley spatial-HAC rejection)" with a parenthetical suffix. NumPy-
style docstring parsers only recognize the bare section names (Notes,
Parameters, etc.); the parenthetical version confused the field-list
parser which then unindented the prior Parameters list incorrectly.
Move the Conley-rejection paragraph into the canonical Notes section
that already existed lower in the docstring, prefixed with a bold
"**Conley spatial-HAC rejection.**" lead-in so the content remains
visually distinguished. No content lost. Verified clean locally with
`python -m sphinx -W -q -b html docs /tmp/sphinx-html` (exit 0).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent f3d5d92 commit 0500909
1 file changed
Lines changed: 12 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
94 | | - | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | 89 | | |
103 | 90 | | |
104 | 91 | | |
| |||
159 | 146 | | |
160 | 147 | | |
161 | 148 | | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
162 | 161 | | |
163 | 162 | | |
164 | 163 | | |
| |||
0 commit comments