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

Use h3 headings for build sections in README #64

Merged
merged 1 commit into from
Feb 28, 2017
Merged

Conversation

eklitzke
Copy link
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

@the-knights-who-say-ni
Copy link

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!

Copy link
Member

@methane methane left a comment

Choose a reason for hiding this comment

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

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

.. contents::

(ref github/markup#391)

README.rst Outdated
@@ -54,7 +54,7 @@ on some platforms. For more details, see the sections bellow.


Profile Guided Optimization
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy link
Member

Choose a reason for hiding this comment

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

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

@eklitzke
Copy link
Contributor Author

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

Copy link
Member

@methane methane left a comment

Choose a reason for hiding this comment

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

LGTM.
Please sign CLA and wait it applied.

@codecov
Copy link

codecov bot commented Feb 13, 2017

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
Copy link
Member

methane commented Feb 20, 2017

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

@methane 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
lysnikolaou pushed a commit to lysnikolaou/cpython that referenced this pull request Apr 7, 2023
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