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

Miscellaneous fixes and formatting enhancements. #238

Merged
merged 4 commits into from
Apr 5, 2017

Conversation

serhiy-storchaka
Copy link
Member

No description provided.

pep-0261.txt Outdated
@@ -74,26 +74,26 @@ user, Python 2.2 will allow the 4-byte implementation as a
build-time option. Users can choose whether they care about
wide characters or prefer to preserve memory.

The 4-byte option is called ``wide Py_UNICODE``. The 2-byte option
is called ``narrow Py_UNICODE``.
The 4-byte option is called "wide ``Py_UNICODE``"". The 2-byte option
Copy link
Member Author

Choose a reason for hiding this comment

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

Typo: a double closing quote.

@@ -102,7 +102,7 @@ belongs, and does not require code to be duplicated.
Syntax
======

The syntax of the while statement::
The syntax of the while statement ::
Copy link
Member

Choose a reason for hiding this comment

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

Does the added space do anything?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it removes a colon from rendered text (but still makes following indented text a code block). The original text/plain version didn't have a colon, and this looks correct to me. "The syntax of the while statement ... is extended as follows: ..." (where "..." are code blocks) is a single sentence, and it shouldn't have a colon after "statement".

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I'm used to seeing that done by putting the :: on its own line.

@@ -69,7 +69,7 @@ Examples
========

Here is an example of an interactive session exhibiting the
expected behaviour of this feature::
expected behaviour of this feature. ::
Copy link
Member

Choose a reason for hiding this comment

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

No, since there is a space between . and ::, colon not rendered.
But I prefer put :: in own line, as @brettcannon's comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I see, thanks for clearing that up.

A dot instead of a comma seems like a good replacement. The comma version, at least for me, not so much. I think it would out of place before a code block (while : seems natural).

@serhiy-storchaka
Copy link
Member Author

Thank you for your review @brettcannon.

@serhiy-storchaka serhiy-storchaka merged commit 7ca8985 into master Apr 5, 2017
@serhiy-storchaka serhiy-storchaka deleted the peps-fixes-and-enhancements branch April 5, 2017 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants