gh-54643: Document the rules for public names in the tutorial - #155344
Open
Phantom0299 wants to merge 1 commit into
Open
gh-54643: Document the rules for public names in the tutorial#155344Phantom0299 wants to merge 1 commit into
Phantom0299 wants to merge 1 commit into
Conversation
Documentation build overview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #54643
This PR adds a new section to modules.rst to clearly document the PEP 8 guidelines for public and private names.
As discussed in the issue, this moves the definition out of the dense language reference and into the tutorial so it is much easier for everyday users to find.
The update clarifies three key rules:
1-How all explicitly defines a public API.
2-The fallback behavior for names without an _ prefix.
3-The rule that imported modules remain private.
Let me know if any of the wording needs to be tweaked!
📚 Documentation preview 📚: https://cpython-previews--.org.readthedocs.build/