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

Rename Doc/README.txt to Doc/README.rst #19

Closed
wants to merge 5 commits into from
Closed

Rename Doc/README.txt to Doc/README.rst #19

wants to merge 5 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Feb 11, 2017

I have simply updated the document and its references to README.rst (thanks to whoever formatted it).

@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 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:

  1. Sign the PSF contributor agreement
  2. 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)
  3. Reply here saying you have completed the above steps

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

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.

Copy link
Member

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.

Copy link
Member

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

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.

@methane
Copy link
Member

methane commented Feb 11, 2017

I think we don't require CLA sign for pull requests like this.

@orsenthil
Copy link
Member

@methane , any patch / contribution requires CLA sign.

@ghost
Copy link
Author

ghost commented Feb 11, 2017

I signed it an hour ago.

@methane
Copy link
Member

methane commented Feb 11, 2017

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)

Copy link
Member

@vstinner vstinner left a 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.

@ghost
Copy link
Author

ghost commented Feb 12, 2017

@methane MY CLA still has not been marked, and I currently have this:

image

It's been two days since I submitted it, any update?

@vstinner
Copy link
Member

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.

@ghost
Copy link
Author

ghost commented Feb 12, 2017

No, it was made in the master branch @Haypo

@ghost
Copy link
Author

ghost commented Feb 12, 2017

@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

@vstinner
Copy link
Member

@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.

Copy link
Member

@vstinner vstinner left a 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/>`_.
Copy link
Member

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

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>`_.
Copy link
Member

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>`_.
Copy link
Member

Choose a reason for hiding this comment

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

..., [prebuilt versions are available].

@ghost
Copy link
Author

ghost commented Feb 13, 2017

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 narayan<>roger<>@<>gmail.com (remove the <>)

@codecov
Copy link

codecov bot commented Feb 13, 2017

Codecov Report

Merging #19 into master will decrease coverage by -0.01%.
The diff coverage is n/a.

@@            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.

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

@ghost
Copy link
Author

ghost commented Feb 13, 2017

@Haypo The changes you requested were made

@ghost
Copy link
Author

ghost commented Feb 13, 2017

It is still not showing up on my account! I have filed a new one for each day it has not been added.

@berkerpeksag
Copy link
Member

Please note that the PSF is based in the United States and they can only process CLA requests in workdays.

@ghost
Copy link
Author

ghost commented Feb 15, 2017

I am moving this PR soon now that my CLA is confirmed and due to overlaps with the master branch.

@ghost ghost closed this Feb 15, 2017
@ghost
Copy link
Author

ghost commented Feb 15, 2017

Moved to #104 and my CLA is now processed

paulmon added a commit to paulmon/cpython that referenced this pull request Jan 10, 2019
nanjekyejoannah added a commit to nanjekyejoannah/cpython that referenced this pull request Feb 1, 2023
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 <jnanjekye@python.org>
oraluben pushed a commit to oraluben/cpython that referenced this pull request Jun 25, 2023
* fix: off by one error in forward jump calculation

* Test: fixed test for python#18

* test: remove broken test

---------

Co-authored-by: Jules <julia.poo.poo.poo@gmail.com>
This pull request was closed.
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.

7 participants