Skip to content

Conversation

@tiagoboldt
Copy link

@tiagoboldt tiagoboldt commented May 22, 2025

PEP 8 mentions that a white line should be included between import types, but does not provide an example for it. People quickly browsing the documentation might overlook this detail. Adding an example ensures readers visualize this recommendation.

  • 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)

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

@python-cla-bot
Copy link

python-cla-bot bot commented May 22, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@AA-Turner
Copy link
Member

-0; I don't think this is needed. There's not much else this line could be interpreted as.

Consider this non-blocking if another editor wants to merge, though.

A

@AA-Turner AA-Turner changed the title PEP 8: Examplify blank line between imports looks like PEP 8: Add an exmple for blank line between imports looks like May 22, 2025
@AA-Turner AA-Turner changed the title PEP 8: Add an exmple for blank line between imports looks like PEP 8: Add an exmple for blank lines between groups of imports May 22, 2025
@Rosuav
Copy link
Contributor

Rosuav commented May 22, 2025

-0.5, also non-blocking but I don't really see the need to have examples of everything. If someone wants to make a separate page somewhere with good and bad examples for everything, sure, but it doesn't need to be part of the main document (and doesn't even need to be anything official - it could just be a page on the Python wiki or something).

@warsaw
Copy link
Member

warsaw commented May 22, 2025

@tiagoboldt Thanks for the contribution, but I agree with the other comments. Not everything needs an example, and adding more text to the PEP can detract from its overall readability. Cheers!

@warsaw warsaw closed this May 22, 2025
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.

4 participants