Skip to content

DOC: Fix missing cross-reference checks for sphinx-tags#28820

Merged
jklymak merged 2 commits intomatplotlib:mainfrom
QuLogic:missing-ref-none
Sep 15, 2024
Merged

DOC: Fix missing cross-reference checks for sphinx-tags#28820
jklymak merged 2 commits intomatplotlib:mainfrom
QuLogic:missing-ref-none

Conversation

@QuLogic
Copy link
Copy Markdown
Member

@QuLogic QuLogic commented Sep 14, 2024

PR summary

In cda4372, I "simplified" from node['refdomain'] to the existing domain argument. With sphinx-tags, the warn-missing-reference event occurs for a None domain, and we crash trying to access domain.name. But node['refdomain'] is still an empty string, so revert back to that.

Noticed this as part of #27302.

PR checklist

In cda4372, I "simplified" from
`node['refdomain']` to the existing `domain` argument. With
`sphinx-tags`, the `warn-missing-reference` event occurs for a `None`
domain, and we crash trying to access `domain.name`. But
`node['refdomain']` is still an empty string, so revert back to that.
@QuLogic QuLogic added the Documentation: build building the docs label Sep 14, 2024
@QuLogic QuLogic added this to the v3.10.0 milestone Sep 14, 2024
@github-actions github-actions Bot removed the Documentation: build building the docs label Sep 14, 2024
@QuLogic QuLogic added the Documentation: build building the docs label Sep 14, 2024
@github-actions github-actions Bot removed the Documentation: build building the docs label Sep 14, 2024
@QuLogic QuLogic added the Documentation: build building the docs label Sep 14, 2024
@jklymak jklymak merged commit 56153b9 into matplotlib:main Sep 15, 2024
@QuLogic QuLogic deleted the missing-ref-none branch September 16, 2024 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: build building the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants