peps icon indicating copy to clipboard operation
peps copied to clipboard

PEP 716: Normalization of Project Names in Metadata and Filenames

Open dstufft opened this issue 2 years ago • 5 comments

Basic requirements (all PEP Types)

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

Standards Track requirements

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

:books: Documentation preview :books:: https://pep-previews--3171.org.readthedocs.build/pep-0716/

dstufft avatar Jun 12 '23 02:06 dstufft

Y'all are gonna get sick of me soon, but here's another one :)

dstufft avatar Jun 12 '23 02:06 dstufft

Y'all are gonna get sick of me soon, but here's another one :)

We'll just reserve the rest of the 7xx series for you ;)

hugovk avatar Jun 12 '23 05:06 hugovk

I've committed most of the suggestions.. I think the remaining ones are just adding line breaks between entries in the numbered list? If y'all think that makes it clearer I'll add them, but the suggestions only did some of them, so I think it makes sense to do either some of them or none of them? Otherwise it feels weird to me to have half of them with extra line breaks, and half not.

WDYT?

dstufft avatar Jun 12 '23 17:06 dstufft

I've committed most of the suggestions.. I think the remaining ones are just adding line breaks between entries in the numbered list? If y'all think that makes it clearer I'll add them, but the suggestions only did some of them, so I think it makes sense to do either some of them or none of them? Otherwise it feels weird to me to have half of them with extra line breaks, and half not.

WDYT?

Yeah, currently only some of them have breaks so looks uneven:

screenshot

image

https://pep-previews--3171.org.readthedocs.build/pep-0716/#motivation

My suggestions were to add the missing ones between 3-4 and 5-6, so they're all consistent. Either that, or remove them from the others. (It's a big list so I favour extra space.)

hugovk avatar Jun 13 '23 07:06 hugovk

Fixed the merge conflict, but there's a lot of comments above to address.

JelleZijlstra avatar Oct 28 '23 23:10 JelleZijlstra