Skip to content

PEP 362: Fix formatting of colons in field descriptions#2590

Merged
JelleZijlstra merged 1 commit intopython:mainfrom
davidfstr:f/sig
May 8, 2022
Merged

PEP 362: Fix formatting of colons in field descriptions#2590
JelleZijlstra merged 1 commit intopython:mainfrom
davidfstr:f/sig

Conversation

@davidfstr
Copy link
Copy Markdown
Contributor

Before:
Screen Shot 2022-05-08 at 12 05 35 PM

After:
Screen Shot 2022-05-08 at 12 06 04 PM

Copy link
Copy Markdown
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.

Looks OK, but I am mystified as to why the colons & trailing text are being stripped... it seems very odd behaviour for list-item handling.

Edit: perhaps as it interacts with the definition list behaviour?

A

@JelleZijlstra JelleZijlstra merged commit 7557f19 into python:main May 8, 2022
@CAM-Gerlach
Copy link
Copy Markdown
Member

Edit: perhaps as it interacts with the definition list behaviour?

That was my guess, and the reST spec seems to confirm that, but its odd that its triggering for an enumerated list...

Optional classifiers may follow the term on the same line, each after an inline " : " (space, colon, space). Inline markup is parsed in the term line before the classifier delimiters are recognized. A delimiter will only be recognized if it appears outside of any inline markup.

   term 3 : classifier
      Definition 3.

Syntax diagram:

+----------------------------+
| term [ " : " classifier ]* |
+--+-------------------------+--+
   | definition                 |
   | (body elements)+           |
   +----------------------------+

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