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

Add ref.any warning sub-type #12739

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Conversation

simaoafonso-pwt
Copy link
Contributor

Subject: Allow for suppression of ambigous "any" xref warnings

Feature or Bugfix

  • Feature

Purpose

  • To allow supressing the ambigous "any" cross-reference warning, mark it with a "ref.any" marker.

Detail

  • This should decrease the amount of spurious warnings, but I agree it should not be enabled by default.

Relates

This is one way to suppress these kinds of warnings.
@AA-Turner
Copy link
Member

This would need an entry in the suppress_warnings list and an entry in CHANGES.rst. Several other warning types have been added recently, for inspiration.

A

@AA-Turner AA-Turner added this to the 8.2.0 milestone Jan 26, 2025
# Conflicts:
#	sphinx/transforms/post_transforms/__init__.py
@AA-Turner AA-Turner marked this pull request as ready for review January 27, 2025 19:25
@AA-Turner AA-Turner changed the title Mark ambigous "any" xref warning with a type and subtype Add ref.any warning sub-type Jan 27, 2025
@AA-Turner AA-Turner merged commit 60f88cc into sphinx-doc:master Jan 27, 2025
22 checks passed
@simaoafonso-pwt simaoafonso-pwt deleted the patch-1 branch January 27, 2025 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants