8000 gh-101100: Fix `load_module` ref by smontanaro · Pull Request #114982 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-101100: Fix load_module ref #114982

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

Closed
wants to merge 2 commits into from
Closed

Conversation

smontanaro
Copy link
Contributor
@smontanaro smontanaro commented Feb 4, 2024

Text describes a user-provided method, perhaps only described in detail in PEP 302.


📚 Documentation preview 📚: https://cpython-previews--114982.org.readthedocs.build/

Text describes a user-provided method, perhaps only described in detail in `PEP 302`.
@AlexWaygood
Copy link
Member
AlexWaygood commented Feb 4, 2024

As I stated in #114729 (comment), this method is described in detail at https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.load_module. But I don't think either suppressing this link or linking to https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.load_module would be the correct way to resolve this reference warning. This glossary entry appears pretty out of date to me; load_module is a deprecated method, that probably shouldn't be mentioned in this glossary entry at all. We should fix the warning by making the entry up-to-date

@smontanaro
Copy link
Contributor Author

The discussion around load_module seems familiar (@AlexWaygood?). I added a reference to the method.

@AlexWaygood
Copy link
Member
AlexWaygood commented Feb 8, 2024

The discussion around load_module seems familiar (@AlexWaygood?). I added a reference to the method.

Yes, we already had this conversation in #114729 (comment). And I still think the best way to correct this reference warning is to update the glossary entry so that it no longer refers to a deprecated method at all.

If that requires an importlib expert, then we should wait for an importlib expert to take a look.

@smontanaro
Copy link
Contributor Author

I will let @AlexWaygood and @serhiy-storchaka sort this out. Let me know your collective decision and I'll change the ref to suit so we can close out this PR.

@serhiy-storchaka
Copy link
Member

I agree that it is better to not refer to the deprecated method. But this requires the larger change that simply adding the exclamation mark.

So this Sphinx warnings serves as a reminder to rewrite the docs.

@AlexWaygood
Copy link
Member

I agree that it is better to not refer to the deprecated method. But this requires the larger change that simply adding the exclamation mark.

So this Sphinx warnings serves as a reminder to rewrite the docs.

Exactly. I would prefer that we leave this Sphinx warning unfixed for now, until we are able to fix it properly, by updating the entry so that it no longer refers to a deprecated method. I said this in #114729 (comment) and #114982 (comment)

@smontanaro
Copy link
Contributor Author

Closing. Will let others decide how best to correct this.

@smontanaro smontanaro closed this Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0