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

Jump to bottom

Doc: Add link to interpreter tutorial #16152

Merged
merged 3 commits into from Sep 16, 2019
Merged

Doc: Add link to interpreter tutorial #16152

merged 3 commits into from Sep 16, 2019

Conversation

adorilson
Copy link
Contributor

@adorilson adorilson commented Sep 14, 2019

Just a link to GNU Readline site.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Sep 14, 2019
aeros
aeros requested changes Sep 15, 2019
View changes
Copy link
Member

@aeros aeros left a comment

Thanks for the PR @adorilson.

+1 on adding the link, I just have a few minor suggestions.

  1. Grammar fix: "systems that support GNU Readline library" should be "systems that support the GNU Readline library".

  2. Use a direct inline link instead of the footer link. The footer links are typically used for links that are likely to be used multiple times within the page, but this one is only being used once. A direct link can be added using:

`GNU Readline <https://tiswww.case.edu/php/chet/readline/rltop.html>`_

(can be split across multiple lines)

  1. Adjust the number of characters per line to fit within the maximum reST 80 character width. Currently, line 37 is at 81 characters and line 40 is at 82 characters. I would suggest adjusting it after making the other adjustments, so that it doesn't have to be done multiple times.

@aeros
Copy link
Member

aeros commented Sep 15, 2019

I would also recommend making an adjustment to the PR title, so that it's easier to tell where the changes are being made from the title alone. Something along the lines of "Doc: Add link to interpreter tutorial" should work.

@adorilson adorilson changed the title add link to GNU Readline site Doc: Add link to interpreter tutorial Sep 15, 2019
aeros
aeros approved these changes Sep 15, 2019
View changes
Copy link
Member

@aeros aeros left a comment

Thanks, LGTM.

@matrixise matrixise self-assigned this Sep 16, 2019
matrixise
matrixise approved these changes Sep 16, 2019
View changes
Copy link
Member

@matrixise matrixise left a comment

Thank you for your contribution

@matrixise matrixise merged commit f18242b into python:master Sep 16, 2019
@miss-islington
Copy link
Contributor

miss-islington commented Sep 16, 2019

Thanks @adorilson for the PR, and @matrixise for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

miss-islington commented Sep 16, 2019

I'm having trouble backporting to 3.8. Reason: 'Error 110 while writing to socket. Connection timed out.'. Please retry by removing and re-adding the needs backport to 3.8 label.

@bedevere-bot
Copy link

bedevere-bot commented Sep 16, 2019

GH-16188 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 16, 2019
@adorilson @miss-islington
Doc: Add link of GNU Readline library to interpreter tutorial (python…
26a6202 
…GH-16152)

(cherry picked from commit f18242b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
@miss-islington
Copy link
Contributor

miss-islington commented Sep 16, 2019

Thanks @adorilson for the PR, and @matrixise for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link

bedevere-bot commented Sep 16, 2019

GH-16189 is a backport of this pull request to the 3.8 branch.

matrixise pushed a commit that referenced this pull request Sep 16, 2019
@miss-islington @adorilson @matrixise
Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152…
ad4ce9e 
…) (GH-16188)

(cherry picked from commit f18242b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
matrixise pushed a commit that referenced this pull request Sep 16, 2019
@miss-islington @adorilson @matrixise
Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152…
9dc381c 
…) (GH-16189)

(cherry picked from commit f18242b)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matrixise matrixise

@aeros aeros

Assignees

@matrixise matrixise

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.

None yet
6 participants
@adorilson @aeros @miss-islington @bedevere-bot @matrixise @the-knights-who-say-ni