FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Use h3 headings for build sections in README by eklitzke · Pull Request #64 · python/cpython · GitHub

/ cpython Public

Use h3 headings for build sections in README - #64

Merged
methane merged 1 commit into
python:masterfrom
eklitzke:docs
Feb 28, 2017
Merged

Use h3 headings for build sections in README#64
methane merged 1 commit into
python:masterfrom
eklitzke:docs

Conversation

Copy link
Copy Markdown
Contributor

I think the sections about different compiler options should be sub-sections of the "Building" section. This change does that -- the LTO and profile-guided optimization sections are now "h3" sections.

You can see how this renders on GitHub at https://github.com/eklitzke/cpython/tree/docs

Copy link
Copy Markdown

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 is necessary for legal reasons before we can look at your contribution. Please follow these steps to help rectify the issue:

  1. If you don't have an account on b.p.o, please create one
  2. Make sure your GitHub username is listed in "Your Details" at b.p.o
  3. If you have not already done so, please sign the PSF contributor agreement
  4. If you just signed the CLA, please wait at least a day and then check "Your Details" on bugs.python.org to see if your account has been marked as having signed the CLA (the delay is due to a person having to manually check your signed CLA)
  5. Reply here saying you have completed the above steps

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

methane left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you for suggestion.
How about adding TOC before "Build Instructions"?

.. contents::

(ref github/markup#391)

Comment thread README.rst Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Please use ^^^^^^^ as subsubsection header.
https://docs.python.org/devguide/documenting.html#sections

Copy link
Copy Markdown
Contributor Author

Add TOC, and used ^^^^ for delimiting the subsections.

methane left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM.
Please sign CLA and wait it applied.

codecov Bot commented Feb 13, 2017

Copy link
Copy Markdown

Codecov Report

Merging #64 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #64   +/-   ##
=======================================
  Coverage   82.37%   82.37%           
=======================================
  Files        1427     1427           
  Lines      350948   350948           
=======================================
  Hits       289091   289091           
  Misses      61857    61857

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 649a7ca...bcfc22c. Read the comment docs.

methane commented Feb 20, 2017

Copy link
Copy Markdown
Member

@eklitzke Could you sign the CLA?
step is described by #64 (comment)

methane merged commit 6db764a into python:master Feb 28, 2017
jaraco pushed a commit to jaraco/cpython that referenced this pull request Feb 17, 2023
jaraco pushed a commit to jaraco/cpython that referenced this pull request Feb 17, 2023
Add an important note about Python < 3.7

Closes python#64

See merge request python-devs/importlib_resources!65
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Apr 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL