Commit d7cd8a4
authored
Fix reStructuredText heading underline consistency in whatsnew (#15189)
## Summary
This PR corrects the reStructuredText (RST) heading underline syntax
throughout the `docs/source/whatsnew/version9.rst` file to follow
consistent formatting conventions.
## Changes Made
- **Main version headings** (e.g., "IPython 9.13"): Changed from `=`
underlines to `-` underlines to use a consistent secondary-level heading
style
- **Section headings** (e.g., "Summary", "Thanks"): Changed from `-`
underlines to `~` underlines to use a consistent tertiary-level heading
style
- **Feature/topic headings**: Changed from `-` underlines to `~`
underlines for consistency
- **Subsection headings** (nested under features): Changed from `~`
underlines to `^` underlines to maintain proper heading hierarchy
## Implementation Details
The changes establish a clear RST heading hierarchy throughout the
document:
1. Top-level version markers (`.. _version X.Y:`) remain unchanged
2. Version numbers use `-` underlines (secondary level)
3. Major sections (Summary, Thanks, feature descriptions) use `~`
underlines (tertiary level)
4. Subsections within features use `^` underlines (quaternary level)
This ensures the document structure is properly recognized by Sphinx and
other RST processors, improving documentation rendering and navigation.
https://claude.ai/code/session_01Y9TW3PKGLoETSQucNMzwMD1 file changed
Lines changed: 56 additions & 56 deletions
0 commit comments