docs: Simplify "More on Lists" section in tutorial#146508
Open
dagangtj wants to merge 1 commit intopython:mainfrom
Open
docs: Simplify "More on Lists" section in tutorial#146508dagangtj wants to merge 1 commit intopython:mainfrom
dagangtj wants to merge 1 commit intopython:mainfrom
Conversation
Simplify the "More on Lists" section by replacing detailed .. method:: directives with concise descriptions and links to the Library Reference. This change: - Removes duplicated method definitions that already exist in the Library Reference - Uses a consistent format matching other built-in types in the tutorial - Adds clear links to the Library Reference for complete documentation Fixes: python#146487
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
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.
This PR simplifies the "More on Lists" section in the tutorial by replacing detailed
.. method::directives with concise descriptions and links to the Library Reference.Changes
.. method::directive blocks with a simple bullet list:meth:~list.method``) and a brief descriptionRationale
As noted in #146487:
.. method::directives to provide formal definitionslistclass was the only built-in class described in such detail in the tutorialThis change brings the list method descriptions in line with how other built-in types (like dict and set) are described in the tutorial—using concise descriptions with links to the full Library Reference documentation.
Verification
make htmlFixes: #146487
📚 Documentation preview 📚: https://cpython-previews--146508.org.readthedocs.build/