-
-
Notifications
You must be signed in to change notification settings - Fork 30.3k
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
Rename Doc/README.txt to Doc/README.rst #19
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 our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow these steps to rectify the issue:
Thanks again to your contribution and we look forward to looking at it! |
@@ -74,7 +74,7 @@ echo. Provided by this script: | |||
echo. clean, check, serve, htmlview | |||
echo. | |||
echo.All arguments past the first one are passed through to sphinx-build as | |||
echo.filenames to build or are ignored. See README.txt in this directory or | |||
echo.filenames to build or are ignored. See README.rst in this directory or |
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.
Doc/README.txt
is still alive.
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.
This PR renames Doc/README.txt to Doc/README.rst.
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.
Ah, I'm sorry. I misundersttod.
@@ -74,7 +74,7 @@ echo. Provided by this script: | |||
echo. clean, check, serve, htmlview | |||
echo. | |||
echo.All arguments past the first one are passed through to sphinx-build as | |||
echo.filenames to build or are ignored. See README.txt in this directory or | |||
echo.filenames to build or are ignored. See README.rst in this directory or |
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.
Ah, I'm sorry. I misundersttod.
I think we don't require CLA sign for pull requests like this. |
@methane , any patch / contribution requires CLA sign. |
I signed it an hour ago. |
|
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.
I suggest to take the opportunity of this change to not only rename README.txt to README.rst but also make some reST syntax enhancements like using reST syntax for links.
@methane MY CLA still has not been marked, and I currently have this: It's been two days since I submitted it, any update? |
Why was this change tagged as "backport to 3.6"? Was it made in the 3.6 branch? If yes, please redo it in the master branch. |
No, it was made in the master branch @Haypo |
@Haypo Can you give me an example as to how you would like the link formatted? I'm more used to writing in markdown than I am in reST |
Look at README.rst in the root directory. |
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.
I suggested different text where [...] is the link.
Doc/README.rst
Outdated
|
||
Bugs in the toolset should be reported in the Sphinx bug tracker at | ||
https://www.bitbucket.org/birkenfeld/sphinx/issues/. | ||
`bitbucket.org/birkenfeld/sphinx/issues/ <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_. |
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.
I suggest "Bugs in the toolset should be reported in the [Sphinx bug tracker]."
Doc/README.rst
Outdated
@@ -109,10 +109,10 @@ Contributing | |||
============ | |||
|
|||
Bugs in the content should be reported to the Python bug tracker at |
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.
"Bugs in the content should be reported to the [Python bug tracker]."
Doc/README.rst
Outdated
used to build the docs. It is not included in this tree, but maintained | ||
separately and available from PyPI <https://pypi.python.org/pypi/Sphinx>. | ||
separately and available from `PyPI <https://pypi.python.org/pypi/Sphinx>`_. |
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.
and [available from PyPI].
Doc/README.rst
Outdated
@@ -3,19 +3,19 @@ Python Documentation README | |||
|
|||
This directory contains the reStructuredText (reST) sources to the Python | |||
documentation. You don't need to build them yourself, prebuilt versions are | |||
available at <https://docs.python.org/dev/download.html>. | |||
available at `docs.python.org/dev/download.html <https://docs.python.org/dev/download.html>`_. |
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.
..., [prebuilt versions are available].
The reason the CLA bot is not showing me as signed is probably because I used the online editor for the original commit (which commits under the noreply@github address). My email address is |
Codecov Report
@@ Coverage Diff @@
## master #19 +/- ##
==========================================
- Coverage 82.37% 82.37% -0.01%
==========================================
Files 1427 1427
Lines 350948 350948
==========================================
- Hits 289091 289089 -2
- Misses 61857 61859 +2 Continue to review full report at Codecov.
|
@Haypo The changes you requested were made |
It is still not showing up on my account! I have filed a new one for each day it has not been added. |
Please note that the PSF is based in the United States and they can only process CLA requests in workdays. |
I am moving this PR soon now that my CLA is confirmed and due to overlaps with the master branch. |
Moved to #104 and my CLA is now processed |
Fix venvlauncher
19: Warn for range and xrange r=ltratt a=nanjekyejoannah See notes: ``` Py2.x: >>> x = xrange(1, 10000) >>> a = range(1,10000) >>> type(a) <type 'list'> >>> Py3.x: >>> x = xrange(1, 10000) Traceback (most recent call last): File "<stdin>", line 1, in <module> NameError: name 'xrange' is not defined >>> a = range(1,10000) >>> type(a) <class 'range'> >>> ``` Co-authored-by: Joannah Nanjekye <[email protected]>
* fix: off by one error in forward jump calculation * Test: fixed test for python#18 * test: remove broken test --------- Co-authored-by: Jules <[email protected]>
I have simply updated the document and its references to README.rst (thanks to whoever formatted it).