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

pep-0557.rst: typos, .. code:: python directives #488

Closed
wants to merge 2 commits into from

Conversation

@westurner
Copy link

@westurner westurner commented Nov 30, 2017

@the-knights-who-say-ni
Copy link

@the-knights-who-say-ni the-knights-who-say-ni commented Nov 30, 2017

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

@westurner

This comment has been minimized.

Copy link
Author

@westurner westurner commented on cb4c3c7 Nov 30, 2017

Sorry, this one shouldn't be "an"; " a" was correct:

 ``repr``: If true (the default), an ``__repr__`` method will be generated.

Note that repr can be dangerous with user-supplied input because of terminal control character injection (e.g. broken syntax highlighting, \r, character set, LEDs,)

http://ascii-table.com/ansi-escape-sequences.php
http://ascii-table.com/ansi-escape-sequences-vt-100.php

@@ -186,10 +194,10 @@ signature. That is, these three uses of ``@dataclass`` are equivalent::
The parameters to ``dataclass`` are:

- ``init``: If true (the default), a ``__init__`` method will be

This comment has been minimized.

@ericvsmith

ericvsmith Nov 30, 2017
Member

I always read these as "a dunder init method", so the original sounds correct to me.

This comment has been minimized.

@westurner

westurner Nov 30, 2017
Author

Fair enough.

@westurner
Copy link
Author

@westurner westurner commented Nov 30, 2017

I've already signed the CLA. And now I've added my github username to the bpo account.

@ericvsmith
Copy link
Member

@ericvsmith ericvsmith commented Nov 30, 2017

I don't see any uses of "code:: python" in any existing PEP, so I'm not inclined to start using it here.

@ericvsmith
Copy link
Member

@ericvsmith ericvsmith commented Nov 30, 2017

Meanwhile, I've fixed the two typos with extra s's that you noted. Thanks.

@brettcannon
Copy link
Member

@brettcannon brettcannon commented Nov 30, 2017

No other PEPs have language directives because we have not had Pygments installed on www.python.org. I know someone was trying to make that happen, but I don't know where that ended up.

@Mariatta
Copy link
Member

@Mariatta Mariatta commented Dec 3, 2017

In python/pythondotorg#1063 (comment) it was said that we'll be moving to Sphinx/Readthedocs so we won't be adding Pygments.

@gvanrossum
Copy link
Member

@gvanrossum gvanrossum commented Jul 7, 2018

I'm guessing this isn't going to be merged, so closing.

@gvanrossum gvanrossum closed this Jul 7, 2018
@westurner
Copy link
Author

@westurner westurner commented Jul 8, 2018

@gvanrossum
Copy link
Member

@gvanrossum gvanrossum commented Jul 8, 2018

That was a real helpful comment, Wes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants