Skip to content

Docs: Add reST directives to c-api/intro#Include_Files #14698

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

Merged
merged 6 commits into from
Sep 10, 2019

Conversation

aeros
Copy link
Contributor

@aeros aeros commented Jul 11, 2019

Adds the following reST directives to the "Include Files" section: code c, important, and note. Also improves the phrasing in the section where a note was added, on lines 99-101.

Since this change is quite minor and doesn't affect the actual message conveyed, I decided to go without creating an issue for it. It's mostly formatting related and an improvement to the phrasing (splits a run-on sentence into two individual ones). This could also go without a news entry, so the skip news and skip issue labels would probably be appropriate.

aeros added 3 commits July 4, 2019 03:24
Adds the following directives to the "Include Files" section: code, important, and note. Also improves the phrasing in the section where a note was added, on lines 99-101.
On line 74, was causing tests to fail
@aeros aeros marked this pull request as ready for review July 11, 2019 04:12
@aeros aeros changed the title Docs: Add RST directives to c-api/intro#Include_Files Docs: Add reST directives to c-api/intro#Include_Files Aug 18, 2019
@aeros
Copy link
Contributor Author

aeros commented Sep 10, 2019

Thanks for the review @benjaminp.

I've removed the code directive, removed the note directive you recommended removing, and replaced the previous important directive I was using with note, which seems to be more appropriate based on the devguide's recommended usage of it. Let me know what you think of the changes.

When I had initially opened this PR, I was significantly less familiar with the usage of reST within the docs. I've gained some experience since then, and likely would not have opened a PR applying those initial changes.

@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 10, 2019
(cherry picked from commit b6dafe5)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 10, 2019
(cherry picked from commit b6dafe5)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
@bedevere-bot
Copy link

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

@aeros
Copy link
Contributor Author

aeros commented Sep 10, 2019

Thanks @benjaminp!

miss-islington added a commit that referenced this pull request Sep 10, 2019
(cherry picked from commit b6dafe5)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
miss-islington added a commit that referenced this pull request Sep 10, 2019
(cherry picked from commit b6dafe5)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants