-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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
Conversation
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:
Thanks again to your contribution and we look forward to looking at it! |
There was a problem hiding this 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 | |||
--------------------------- | |||
~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
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
Add TOC, and used ^^^^ for delimiting the subsections. |
There was a problem hiding this 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 Report
@@ 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.
|
@eklitzke Could you sign the CLA? |
Add an important note about Python < 3.7 Closes python#64 See merge request python-devs/importlib_resources!65
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