Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jakkdl opened this issue Sep 18, 2024 · 0 comments
Labels
docs Documentation in the Doc dir

Comments

@jakkdl
Copy link

jakkdl commented Sep 18, 2024

Documentation

I don't see any reason for these two pages to have slight differences in their wording, and should be made consistent to avoid any confusion.

https://docs.python.org/3/library/warnings.html#warning-categories

SyntaxWarning: Base category for warnings about dubious syntactic features.
RuntimeWarning: Base category for warnings about dubious runtime features.

https://docs.python.org/3/library/exceptions.html#SyntaxWarning

Base class for warnings about dubious syntax.

https://docs.python.org/3/library/exceptions.html#RuntimeWarning

Base class for warnings about dubious runtime behavior.

Looking at the other warning descriptions:

  1. Warning description should probably be synced as well
  2. UserWarning same
  3. EncodingWarning is missing from https://docs.python.org/3/library/warnings.html#warning-categories
  4. And the order the warnings are listed in differs

The rest are either identical or have substantial differences that look intentional. Though perhaps these should be automatically synced/generated from the same source

@jakkdl jakkdl added the docs Documentation in the Doc dir label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

1 participant