Skip to content

Remove trailing >>> in enum docs #21358

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 9, 2020
Merged

Remove trailing >>> in enum docs #21358

merged 2 commits into from
Jul 9, 2020

Conversation

E-Paine
Copy link
Contributor

@E-Paine E-Paine commented Jul 6, 2020

The enum docs has a trailing >>> which is not expected by sphinx and so is not coloured correctly (it is left black).

@E-Paine E-Paine requested a review from ethanfurman as a code owner July 6, 2020 19:32
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jul 6, 2020
@ethanfurman
Copy link
Member

@E-Paine: would you like your name in Misc/ACKS ? If so, please add yourself. I'll merge the changes when that's done or you let me know that you do not desire it.

Thank you for the fix!

@E-Paine
Copy link
Contributor Author

E-Paine commented Jul 6, 2020

@ethanfurman, thanks but isn't ACKS for non-trivial patches?

@ethanfurman
Copy link
Member

From the header of that file:

Acknowledgements

This list is not complete and not in any useful order, but I would
like to thank everybody who contributed in any way, with code, hints,
bug reports, ideas, moral support, endorsement, or even complaints....
Without you, I would've stopped working on Python long ago!

--Guido

So I think adding yourself is appropriate. If adding yourself makes you want to fix more docs so you feel better about it, I'm okay with that! :-)

@E-Paine
Copy link
Contributor Author

E-Paine commented Jul 7, 2020

@ethanfurman thanks again. I hope to keep contributing for a while yet...

@ethanfurman ethanfurman merged commit 1ee5dc1 into python:master Jul 9, 2020
@E-Paine E-Paine deleted the enum-doc-update branch July 10, 2020 08:41
arun-mani-j pushed a commit to arun-mani-j/cpython that referenced this pull request Jul 21, 2020
@E-Paine @arun-mani-j
Remove trailing >>> in enum docs (pythonGH-21358)
752697f 
The >>> as the last line serve no purpose and are not colored correctly by Sphinx.
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 20, 2020
@E-Paine @shihai1991
Remove trailing >>> in enum docs (pythonGH-21358)
ae339e3 
The >>> as the last line serve no purpose and are not colored correctly by Sphinx.
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
@E-Paine
Remove trailing >>> in enum docs (pythonGH-21358)
d9e4428 
The >>> as the last line serve no purpose and are not colored correctly by Sphinx.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ethanfurman ethanfurman ethanfurman approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@E-Paine @ethanfurman @the-knights-who-say-ni @bedevere-bot