Skip to content

Conversation

@vwheeler63
Copy link
Contributor

Purpose

Documentation in ./doc/extdev/event_callbacks.rst showed 2 events with an old (or incomplete) list of arguments in the "Core events overview" section, specifically their leading app argument. This was remedied.

References

  • Python/Lib/site-packages/sphinx/domains/std/init.py line 1443 function:
    def warn_missing_reference(
        app: Sphinx,
        domain: Domain,
        node: pending_xref,
    ) -> bool | None:
        ...
  • Python/Lib/site-packages/sphinx/ext/intersphinx/_resolve.py line 339 function:
    def missing_reference(
        app: Sphinx, env: BuildEnvironment, node: pending_xref, contnode: TextElement
    ) -> nodes.reference | None:
        """Attempt to resolve a missing reference via intersphinx references."""
        return resolve_reference_detect_inventory(env, node, contnode)

@AA-Turner AA-Turner changed the title docs(event_callbacks.rst): updated arg lists for 2 events Update arg lists for 2 events in event_callbacks.rst May 20, 2025
@AA-Turner AA-Turner merged commit ad360fd into sphinx-doc:master May 21, 2025
7 checks passed
@vwheeler63 vwheeler63 deleted the docs/update_event_arg_lists branch May 21, 2025 01:42
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 19, 2025
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.

2 participants