Skip to content

gh-124205: Align warning category documentation - #157255

Open
owenthcarey wants to merge 1 commit into
python:mainfrom
owenthcarey:docs-124205-warning-categories
Open

gh-124205: Align warning category documentation#157255
owenthcarey wants to merge 1 commit into
python:mainfrom
owenthcarey:docs-124205-warning-categories

Conversation

@owenthcarey

@owenthcarey owenthcarey commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Align the warning-category descriptions and ordering with the built-in exceptions documentation, and add the missing EncodingWarning entry so both pages describe the same categories consistently.

Validated with a fresh full HTML documentation build and the pre-commit checks for the changed file.

Closes #124205.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34485297 | 📁 Comparing 3a428f0 against main (f715d25)

  🔍 Preview build  

1 file changed
± library/warnings.html

Comment thread Doc/library/warnings.rst
| :exc:`Warning` | This is the base class of all warning |
| | category classes. It is a subclass of |
| | :exc:`Exception`. |
| :exc:`Warning` | Base class for warning categories. It's a |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| :exc:`Warning` | Base class for warning categories. It's a |
| :exc:`Warning` | Base class for warning categories. It is a |

I'd prefer to revert this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Minor inconsistency in description of Warnings between warnings.html and exceptions.html

2 participants