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.

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

Move footnote marker closer to the related term, before sentence's ending dot #4518

Merged
merged 2 commits into from
Nov 24, 2017
Merged

Move footnote marker closer to the related term, before sentence's ending dot #4518

merged 2 commits into from
Nov 24, 2017

Conversation

lelit
Copy link
Contributor

@lelit lelit commented Nov 23, 2017

This cures a minor aesthetic issue in the Extending Python section of the documentation.

Mariatta
Mariatta requested changes Nov 24, 2017
View reviewed changes
Doc/extending/extending.rst Outdated
@@ -40,7 +40,7 @@ A Simple Example

Let's create an extension module called ``spam`` (the favorite food of Monty
Python fans...) and let's say we want to create a Python interface to the C
library function :c:func:`system`. [#]_ This function takes a null-terminated
library function :c:func:`system`\ [#]_. This function takes a null-terminated
Copy link
Member

Choose a reason for hiding this comment

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

The \ is not needed. It should just be:

:c:func:`system` [#]_.

Doc/extending/extending.rst Outdated
@@ -913,11 +913,11 @@ needed. Ownership of a reference can be transferred. There are three ways to
dispose of an owned reference: pass it on, store it, or call :c:func:`Py_DECREF`.
Forgetting to dispose of an owned reference creates a memory leak.

It is also possible to :dfn:`borrow` [#]_ a reference to an object. The
It is also possible to :dfn:`borrow`\ [#]_ a reference to an object. The
Copy link
Member

Choose a reason for hiding this comment

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

The \ is not needed.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Mariatta
Mariatta approved these changes Nov 24, 2017
View reviewed changes
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

The earlier change request was so trivial, I made the change myself to your branch :) Hope that's ok.
Everything else looks good. Once CI passed, this should be good to merge.

@Mariatta Mariatta merged commit cdfe910 into python:master Nov 24, 2017
@miss-islington
Copy link
Contributor

Thanks @lelit for the PR, and @Mariatta for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 24, 2017
@lelit @miss-islington
Extending Python Doc minor updates (pythonGH-4518)
fc3f302 
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910)
@bedevere-bot
Copy link

GH-4535 is a backport of this pull request to the 3.6 branch.

@Mariatta
Copy link
Member

Thanks @lelit and congrats on your first contribution to CPython 🌮

@bedevere-bot
Copy link

GH-4536 is a backport of this pull request to the 2.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 24, 2017
@lelit @miss-islington
Extending Python Doc minor updates (pythonGH-4518)
d95e622 
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910)
Mariatta pushed a commit that referenced this pull request Nov 24, 2017
@miss-islington @Mariatta
Extending Python Doc minor updates (GH-4518) (GH-4535)
90abbee 
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910)
Mariatta pushed a commit that referenced this pull request Nov 24, 2017
@miss-islington @Mariatta
Extending Python Doc minor updates (GH-4518) (GH-4536)
66cdc84 
Move footnote markers to be closer to the related terminology:
before the end of the sentence, instead of after.
(cherry picked from commit cdfe910)
@lelit lelit deleted the cosmetic-rst-markup-fix branch November 24, 2017 14:16
@lelit
Copy link
Contributor Author

lelit commented Nov 24, 2017

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mariatta Mariatta Mariatta approved these changes

Assignees
No one assigned
Labels
skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@lelit @bedevere-bot @miss-islington @Mariatta @the-knights-who-say-ni