PEP 681: Fix minor formatting and typographical issues #2382
Conversation
In python.org's PEP rendering, with tall per-line spacing, this wastes a lot of space.
Why: * ```-style headers confuse the syntax-highlighting in my text editor. * I believe '''-style headers are also recommended by the PEP rST template for this level of header, but I haven't confirmed.
|
CC @debonte (PEP Author) |
Correct! 👍 First-Level Title
=================
Second-Level Title
------------------
Third-Level Title
''''''''''''''''' |
CAM-Gerlach
changed the title
There was a problem hiding this comment.
LGTM, thanks! Some clarifications:
Just to make sure we're clear, this is only needed for PEPs that have custom inline link text, which by extension includes those linking to sections (as here). For "normal" :pep:`1` links, "PEP" is prepended automatically as part of the generated inline link text.
The FF (form feed) character is needed for Emacs to recognize the Emacs editor configuration block that follows it at the end of the file. Previously, this was required and included in all PEPs, but as it is effectively obsolete (given only a few PEP editors/authors still use Emacs, and those that do pretty much all use rst-mode which renders this unnecessary) this requirement was formally removed in #2374 .
Without the FF character the following block is (AFAIK) useless, so if you eliminate that, the Emacs config comment following it should be removed as well, or otherwise both should be left alone (and the commit dropped).
|
@davidfstr, based on #2374 and @CAM-Gerlach's comment above, I'd say we should remove the Emacs configuration block at the end of the file. Thanks for these changes! |
|
I believe all feedback has been integrated and this PR is ready to merge. 👍 |
Please see individual commit messages for explanation of each change made.