intersphinx: Reduce log message severity when ambiguous target resolves to a duplicate #12587
Conversation
…report/false-positive case sphinx-doc#12585
…finitions in `objects.inv` entries.
…ambiguous-but-duplicate intersphinx resolutions.
…ion (and add corresponding type-hint).
…on' into issue-12585-extra/objectsinv-resolution-ambiguity-false-positive-reduction
…biguity-false-positive-reduction Conflicts: sphinx/util/inventory.py
jayaddison
changed the title
jayaddison
changed the title
…biguity-false-positive-reduction
|
@AA-Turner a note to let you know that I'm holding this change in reserve - it is about Intersphinx resolution -- e.g. occurs when people attempt to include links to potential ambiguity in external projects from their own. This should happen far less often than ambiguity-detection at inventory loading-time, and I think is a more serious scenario (because it could result in incorrect hyperlinks). Even so, the pure-duplicate case might make sense to reduce log-severity for here too. |
|
(I'm not sure that I explained that particularly clearly, so let me know if I can clarify. there are a few similar-seeming changes in-flight here, and I regret that because I could have planned this rollout better to reduce the chance of confusion) |
…biguity-false-positive-reduction Conflicts: CHANGES.rst
|
Following the principle of "who is this warning actionable for" (ref here), I don't think that either the referrer or the referee are likely to want or need to do anything about ambiguities that are effectively duplicate entries. It's potentially useful to be aware of these cases, but not something that should block strict-mode builds. |
This comment was marked as resolved.
This comment was marked as resolved.
…biguity-false-positive-reduction Conflicts: CHANGES.rst (manual adjustment)
This comment was marked as resolved.
This comment was marked as resolved.
|
Does this address a regression in 7.4? Otherwise I will hold off until 7.5 // 8.0. A |
It does not, no - and that sounds fine to me, thank you 👍 |
jayaddison
changed the title
…biguity-false-positive-reduction Conflicts: CHANGES.rst tests/test_extensions/test_ext_intersphinx.py
jayaddison
deleted the
issue-12585-extra/objectsinv-resolution-ambiguity-false-positive-reduction
branch
|
Thanks again! |
Feature or Bugfix
Purpose
Detail
Usehowever, do use a set to count the number of distinct matched definitions at resolution-time.set-comparison of the reference fields.debugmessages for reference.Relates
Edit: redraft description since #12586 was merged separately.
Edit: remove resolves-issue reference.