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

PEP 750: major updates to "Template Strings" based on community feedback #4062

Merged
merged 173 commits into from
Oct 22, 2024

Conversation

davepeck
Copy link
Contributor

@davepeck davepeck commented Oct 16, 2024

  • Change is either:
    • To a Draft PEP
    • To an Accepted or Final PEP, with Steering Council approval
    • To fix an editorial issue (markup, typo, link, header, etc)
  • PR title prefixed with PEP number (e.g. PEP 123: Summary of changes)

This PR contains substantial updates to PEP 750 based on feedback from the broader Python community, including comments on the official PEP Discourse thread and in-person core team feedback at the recent Bellevue, WA, USA sprint.

It has been reviewed by:

Koudai Aono (@koxudaxi) and I were both added as co-authors.


Basic requirements (all PEP Types)

  • Read and followed PEP 1 & PEP 12
  • File created from the latest PEP template
  • PEP has next available number, & set in filename (pep-NNNN.rst), PR title (PEP 123: <Title of PEP>) and PEP header
  • Title clearly, accurately and concisely describes the content in 79 characters or less
  • Core dev/PEP editor listed as Author or Sponsor, and formally confirmed their approval
  • Author, Status (Draft), Type and Created headers filled out correctly
  • PEP-Delegate, Topic, Requires and Replaces headers completed if appropriate
  • Required sections included
    • Abstract (first section)
    • Copyright (last section; exact wording from template required)
  • Code is well-formatted (PEP 7/PEP 8) and is in code blocks, with the right lexer names if non-Python
  • PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
  • Authors/sponsor added to .github/CODEOWNERS for the PEP

Standards Track requirements

  • PEP topic discussed in a suitable venue with general agreement that a PEP is appropriate
  • Suggested sections included (unless not applicable)
    • Motivation
    • Rationale
    • Specification
    • Backwards Compatibility
    • Security Implications
    • How to Teach This
    • Reference Implementation
    • Rejected Ideas
    • Open Issues
  • Python-Version set to valid (pre-beta) future Python version, if relevant
  • Any project stated in the PEP as supporting/endorsing/benefiting from the PEP formally confirmed such (not relevant?)
  • Right before or after initial merging, PEP discussion thread created and linked to in Discussions-To and Post-History (the existing Discourse thread is found here )

📚 Documentation preview 📚: https://pep-previews--4062.org.readthedocs.build/pep-0750/

davepeck and others added 30 commits September 27, 2024 13:36
Update PEP 750 to use Template and Interpolation classes in a proposal part
Modified the `Interpolation` class definition, changing it from a `Protocol` to a regular class. Updated various instances in the PEP to reflect changes in syntax and terminology, replacing `tag function` with `template function` where appropriate.
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
peps/pep-0750.rst Outdated Show resolved Hide resolved
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for putting up with me @davepeck! This seems in a good state to merge (I've left a comment on templatelib on the thread, but it's non editorial.)

Do you have anything outstanding before merging? We should probably get this in before it hits 200 commits, and anything missed can be covered in a follow up.

Thank you again!

A

@davepeck
Copy link
Contributor Author

Thank you for putting up with me @davepeck!

On the contrary, thank you for putting up with me and my zillion edits! :-)

This seems in a good state to merge (I've left a comment on templatelib on the thread, but it's non editorial.)

Yes, at this point, I think we can merge. We'll need another turn of the crank for sure, but it's in a good place for now.

peps/pep-0750.rst Outdated Show resolved Hide resolved
Co-authored-by: Nice Zombies <[email protected]>
@AA-Turner AA-Turner merged commit d3b4ab6 into python:main Oct 22, 2024
5 checks passed
@AA-Turner
Copy link
Member

Thanks @davepeck!

A

ncoghlan pushed a commit to ncoghlan/peps that referenced this pull request Oct 23, 2024
…ack (python#4062)

Co-authored-by: Koudai Aono <[email protected]>
Co-authored-by: pauleveritt <[email protected]>
Co-authored-by: Lysandros Nikolaou <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Nice Zombies <[email protected]>
gvanrossum pushed a commit to gvanrossum/peps that referenced this pull request Dec 10, 2024
…ack (python#4062)

Co-authored-by: Koudai Aono <[email protected]>
Co-authored-by: pauleveritt <[email protected]>
Co-authored-by: Lysandros Nikolaou <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Nice Zombies <[email protected]>
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.

10 participants