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

👌 Make ExtensionMetadata type public and use it in internal extensions #12153

Merged

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Mar 20, 2024

This type alias has now been fully documented for public consumption.

This will be beneficial to the sphinx ecosystem,
to aide/encourage extension developers to provide the correct metadata.

I really don't see the rationale for this being private;
I feel it would be very good practice to encourage extensions to use it,
and thus make it more likely for them to provide the correct metadata.
Copy link
Contributor

@danieleades danieleades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

big fan of this.

i've even redefined my own return type in plugins to keep mypy happy, so this would be a big improvement

sphinx/util/typing.py Outdated Show resolved Hide resolved
sphinx/util/typing.py Outdated Show resolved Hide resolved
sphinx/util/typing.py Outdated Show resolved Hide resolved
sphinx/util/typing.py Outdated Show resolved Hide resolved
@picnixz
Copy link
Member

picnixz commented Mar 21, 2024

I really don't see the rationale for this being private;

The rationale was probably because we did not document it when we introduced it at first.

@chrisjsewell
Copy link
Member Author

The rationale was probably because we did not document it when we introduced it at first.

fair, well now that is all done 😄

sphinx/util/typing.py Outdated Show resolved Hide resolved
Co-authored-by: Bénédikt Tran <[email protected]>
@chrisjsewell chrisjsewell changed the title 👌 Make ExtensionMetadata typed dict public and use it in internal extensions 👌 Make ExtensionMetadata type public and use it in internal extensions Mar 21, 2024
CHANGES.rst Outdated Show resolved Hide resolved
@danieleades
Copy link
Contributor

just let me know when this is released and i can start using it!

@chrisjsewell chrisjsewell merged commit d59b158 into sphinx-doc:master Mar 21, 2024
22 checks passed
@chrisjsewell chrisjsewell deleted the make-ExtensionMetadata-public branch March 21, 2024 15:19
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2024
@AA-Turner AA-Turner added this to the 7.3.0 milestone Jul 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants