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

Turn show_warning_types on by default #12597

Merged
merged 5 commits into from
Jul 20, 2024

Conversation

chrisjsewell
Copy link
Member

In #12131 I added the show_warning_types, to show the warning type/subtype.
As I explained there, I think this is very helpful for helping users understand the source of the warning and understand how to suppress it if desired,
and also it is inline with the tools in the Python ecosystem (mypy, ruff, pylint, ...)

As per python/mypy#13542, here I am advocating for making this on by default.

I feel that although it was a good step to add the functionality, still most users will not realise it is possible and there is no real downside to having this on by default

@picnixz
Copy link
Member

picnixz commented Jul 16, 2024

I'm not sure about this one. It might break automated tools that parse the output of the log depending on how they parse it. Maybe for 8.x but this is a breaking change IMO. What you can however do is change the default project template or at least, put it in comment so that users know about this feature.

(Personally, I don't mind, but I don't want to break things (but maybe for 8.x?))

@chrisjsewell
Copy link
Member Author

Maybe for 8.x but this is a breaking change IMO.

Yep, that's why I opened it now after the minor release

@picnixz picnixz added this to the 8.x milestone Jul 16, 2024
@AA-Turner AA-Turner modified the milestones: 8.x, 8.0.0 Jul 20, 2024
@AA-Turner AA-Turner changed the title [config] Change show_warning_types default to True Turn show_warning_types on by default Jul 20, 2024
@AA-Turner AA-Turner merged commit dabacdf into sphinx-doc:master Jul 20, 2024
21 checks passed
@chrisjsewell
Copy link
Member Author

Cheers

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants