Skip to content

/ cpython

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

Jump to bottom

bpo-42128: Add documentation for pattern matching (PEP 634) #24664

Draft
wants to merge 23 commits into
base: master
from
Draft

bpo-42128: Add documentation for pattern matching (PEP 634) #24664

wants to merge 23 commits into from
+826 −3

Conversation

@dmoisset
Copy link

@dmoisset dmoisset commented Feb 27, 2021 •
edited

This covers documentation for the new match statement in 3.10, as requested by the SC in https://mail.python.org/archives/list/python-committers@python.org/message/SQC2FTLFV5A7DV7RCEAR2I2IKJKGK7W3/

The documentation includes:

  • A large language reference update include syntax and behaviour of the match statement, largely based on the relevant sections of PEP-634 in the compound statements section.
  • A significant new section in the "control flow" chapter of the tutorial based on the Appendix A of PEP-636
  • An update to the "data model" reference chapter describing the new special attribute __match_args__
  • A new section in the "lexical analysis" chapter describing the use of soft keywords.
  • An update to the FAQ entry about "Why isn't there a switch or case statement in Python?"

https://bugs.python.org/issue42128
dmoisset and others added 21 commits Feb 23, 2021
@dmoisset
Add section on soft keywords "match" and "case"
f8ef095
@dmoisset
Add tutorial on pattern matching
2a1b2e1 
The tutorial is a slightly modified version of PEP-636 Appendix A
@Fidget-Spinner @dmoisset
move index and link down to correct (original) location, add index fo…
83495ea 
…r soft keywords
@dmoisset
Add "_" as a soft keyword
4fda91c
@dmoisset
Add __match_args__ to the data model
f07fe3e
@Fidget-Spinner @dmoisset
Add versionadded to datamodel
72ce7cc
@Fidget-Spinner @dmoisset
Rename __match_args__ section link
faa0450
@Fidget-Spinner @dmoisset
object.__match_args__ -> class.__match_args__
0392e9c
@dmoisset
Refer to match wherever the C switch statement was compared with Python.
e9a33ed 
Brought up in https://bugs.python.org/msg387769
@dmoisset
Revert "object.__match_args__ -> class.__match_args__"
734dfea 
This reverts commit 6320747.
@dmoisset
Refer to the PEP tutorial from the tutorial
cd736dd
@Fidget-Spinner @dmoisset
@gvanrossum @brandtbucher
Add half of PEP 634 (lots of TODOs left)
bdcf259 
Co-Authored-By: Daniel F Moisset <dfmoisset@gmail.com>
Co-Authored-By: Guido van Rossum <2894642+gvanrossum@users.noreply.github.com>
Co-Authored-By: Brandt Bucher <brandt@python.org>
@Fidget-Spinner @rhettinger @dmoisset
use better wording and add lots of lists and tables (still lots of TO…
0e2d768 
…DOs left)

one table idea was inspired by Raymond's awesome tweet here https://twitter.com/raymondh/status/1361780586570948609

Co-Authored-By: Raymond Hettinger <1623689+rhettinger@users.noreply.github.com>
@Fidget-Spinner @dmoisset
done!
2790c6e
@Fidget-Spinner @dmoisset
Apply suggested changes from code review by Daniel (part 1)
82aa7dc 
Co-authored-by: Daniel F Moisset <dfmoisset@gmail.com>
@Fidget-Spinner @dmoisset
Apply final suggestions
ab3ca5a
@Fidget-Spinner @dmoisset
Add link, make grammar and links consistent with rest of docs
26ef46d
@Fidget-Spinner @dmoisset
touch up table
f13eb7f
@Fidget-Spinner @dmoisset
Add the datamodel __match_args__ links in
43e9419
@dmoisset
Apply suggestions from code review
3bb4f3f 
Some minor typos, and copy/paste fixes
@dmoisset
Fix documentation build errors
Loading status checks…
0b3d46a
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Feb 27, 2021
@bedevere-bot bedevere-bot added type-documentation awaiting review labels Feb 27, 2021
blurb-it bot and others added 2 commits Feb 27, 2021
@blurb-it
📜🤖 Added by blurb_it.
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
d0ce4d8
@dmoisset
Clean linter issues
Loading status checks…
3d8cbd6
@dmoisset
Copy link
Author

@dmoisset dmoisset commented Feb 28, 2021

This is currently a Draft PR because I plan to make some minor adjustments, but it should be "complete" and reviewable at this point. The planned changes are likely to be some removals/rearranging of content in the "Doc/reference/compound_stmts.rst" file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CLA signed awaiting review type-documentation
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
@dmoisset @the-knights-who-say-ni @bedevere-bot @Fidget-Spinner