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

intersphinx: Don't warn about pure-duplicate ambiguous definitions when loading 'objects.inv' entries. #12586

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Jul 15, 2024

Feature or Bugfix

  • Bugfix

Purpose

  • Don't emit a warning at inventory load time if two ambiguously-resolved Intersphinx objects.inv entries resolve to exactly the same result (i.e. are duplicates that differ only by lowercase/uppercase characters).

Detail

  • Use set-comparison of the reference fields.
  • Do log a debug message for reference.

Todo / open questions

Relates

Edit: clarify the false-positive warning that is filtered by this branch.

@jayaddison jayaddison changed the title Issue 12585/objectsinv ambiguity false positive reduction intersphinx ambiguities: don't warn about pure-duplicate ambiguous definitions in 'objects.inv' entries. Jul 15, 2024
@jayaddison jayaddison changed the title intersphinx ambiguities: don't warn about pure-duplicate ambiguous definitions in 'objects.inv' entries. intersphinx: Don't warn about pure-duplicate ambiguous definitions when loading 'objects.inv' entries. Jul 15, 2024
@jayaddison

This comment was marked as resolved.

sphinx/util/inventory.py Outdated Show resolved Hide resolved
sphinx/util/inventory.py Show resolved Hide resolved
@AA-Turner AA-Turner merged commit cfd3645 into sphinx-doc:master Jul 15, 2024
21 checks passed
@AA-Turner
Copy link
Member

Oh, this should have had a CHANGES entry...

A

@jayaddison jayaddison deleted the issue-12585/objectsinv-ambiguity-false-positive-reduction branch July 15, 2024 17:43
@jayaddison
Copy link
Contributor Author

Oh, this should have had a CHANGES entry...

"Reduce log severity of detected ambiguous Intersphinx inventory items that are found to be case-insensitive duplicates." ?

@jayaddison
Copy link
Contributor Author

(rationale: they are still resolved ambiguously, but since they're duplicates, they're basically innocuous)

AA-Turner added a commit that referenced this pull request Jul 15, 2024
@AA-Turner
Copy link
Member

Added a variant of that as 12064e0.

A

@jayaddison
Copy link
Contributor Author

Thank you!

@AA-Turner AA-Turner added this to the 7.4.x milestone Jul 17, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 17, 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.

Warning about duplicate definitions in intersphinx mapping
2 participants