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

Avoid env.temp_data.update() #79

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AA-Turner
Copy link

Hello,

In Sphinx, we are looking to change temp_data from a dict to a better-typed object (c.f. sphinx-doc/sphinx#13151). This change will be backward compatible, but this repo is one of only two instances I have found of temp_data.update(), and currently temp_data is not really public API de jure. This PR ought to maintain the current behaviour, and will be forward-compatible should we look to deprecate .update() in the future.

A

@chipx86
Copy link
Member

chipx86 commented Jan 4, 2025

I appreciate the fix! Thanks for sending that our way. We'll get it merged.

@chipx86
Copy link
Member

chipx86 commented Jan 4, 2025

We really should avoid touching the internals too much. I'll have to see if there's a better way of doing what we're trying to do at some point. I think we also reach into some internals over at https://github.com/beanbaginc/beanbag-docutils, but we do so fully understanding the Sphinx project owes us nothing and that any new release may break us.

Thanks for all the work on Sphinx, by the way. It's one of my favorite tools in the Python ecosystem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants