Rename README to README.rst and enhance formatting by vstinner · Pull Request #2

Rename README to README.rst and enhance formatting by vstinner · Pull Request #2 · python/cpython

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

Conversation

README.rst is recognized by GitHub which will render the README as reStructured text (nice!), instead of plain text.

Example with my tiny project https://github.com/haypo/perf which has a README.rst file.

I checked if the "README" file was referenced directly somewhere: I only found Makefile.pre.in.

Copy link

Member

zware commented Feb 10, 2017

This could use some additional formatting enhancement, such as changing things like "./configure --help" to

Also, links can be turned into linked text rather than written out URLs.

@zware: I hesitated, but ok: I made these changes.

I also added a link to the python-ideas mailing list, and I updated the Release Schedule to the Python 3.7 PEP.



		Release Schedule
		----------------

		See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/
		See `PEP 537 <https://www.python.org/dev/peps/pep-0537/>`_ for Python 3.7

Choose a reason for hiding this comment

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

Basic reST supports :pep:'537' (replace quotes with backticks because lol markdown)

Choose a reason for hiding this comment

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

I tried locally using rst2html tool. Sadly, this tool uses the old HTTP link, whereas www.python.org moved to HTTPS. I prefer to use HTTPS.

Choose a reason for hiding this comment

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

We should see which one Github uses, if either :)

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

Damn! docutils predates universal HTTPS.

Copy link

Member

zware left a comment

A couple of minor things, but mostly looks good!

		Python executable in a place that is not normally on your PATH, you may want to
		set up a symlink in /usr/local/bin.
		set up a symlink in ``/usr/local/bin``.

		On Windows, see PCbuild/readme.txt.

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

Such change are out of the scope of my initial change. I suggest to make more enhancements in a second change.

		primary version, you would execute "make install" in your 3.7 build directory
		and "make altinstall" in the others.
		primary version, you would execute ``make install`` in your 3.7 build directory
		and ``make altinstall`` in the others.


		Issue Tracker and Mailing List
		------------------------------

		We're soliciting bug reports about all aspects of the language. Fixes are also
		welcome, preferably in unified diff format. Please use the issue tracker:

Choose a reason for hiding this comment

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

This whole section can use updating:

Bug reports are welcome!  You can use the `issue tracker
<https://bugs.python.org>`_ to report bugs, and/or submit pull requests `on
Github <https://github.com/python/cpython>`_.

You can also follow development discussion on the `python-dev mailing list
<https://mail.python.org/mailman/listinfo/python-dev/>`_.

Choose a reason for hiding this comment

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

Ditto.



		Release Schedule
		----------------

		See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/
		See `PEP 537 <https://www.python.org/dev/peps/pep-0537/>`_ for Python 3.7

Choose a reason for hiding this comment

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

We should see which one Github uses, if either :)

Update also the Release Schedule to Python 3.7.

Ok, it seems like Eric and Zach want :pep:537: so I made this change.

But I prefer to restrict this change to converting README to README.rst and fix/enhance reST syntax. If you want to more general update/enhancements of README, I suggest to work on a new change based on mine.

Copy link

Member

zware left a comment

Copy link

Member

zware commented Feb 11, 2017

I'd recommend to report that as a bug to Github :). It is at least redirected to https automatically.

zware referenced this pull request in zware/cpython

Feb 14, 2017

zware mentioned this pull request

Feb 14, 2017

zware added a commit that referenced this pull request

Feb 15, 2017

Do we want to backport this to 3.5 and 2.7?

This change causes issues with Windows installer, check with Steve Dower (sorry I don't recall the bpo number).

tiran referenced this pull request in tiran/cpython

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    #0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    #1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    #2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>

tiran mentioned this pull request

Jun 12, 2020

miss-islington pushed a commit that referenced this pull request

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    #0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    #1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    #2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>

miss-islington referenced this pull request in miss-islington/cpython

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    GH-0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    GH-1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    GH-2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 0d3350d)

Co-authored-by: Christian Heimes <christian@python.org>

This was referenced

Jun 12, 2020

miss-islington referenced this pull request in miss-islington/cpython

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    GH-0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    GH-1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    GH-2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 0d3350d)

Co-authored-by: Christian Heimes <christian@python.org>

miss-islington referenced this pull request in miss-islington/cpython

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    GH-0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    GH-1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    GH-2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 0d3350d)

Co-authored-by: Christian Heimes <christian@python.org>

miss-islington added a commit that referenced this pull request

Jun 12, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    GH-0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    GH-1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    GH-2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 0d3350d)

Co-authored-by: Christian Heimes <christian@python.org>

arun-mani-j pushed a commit to arun-mani-j/cpython that referenced this pull request

Jul 21, 2020

```
Direct leak of 8 byte(s) in 1 object(s) allocated from:
    #0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667)
    #1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774
    python#2 0xe0305b in cfunction_call Objects/methodobject.c:546
```

Signed-off-by: Christian Heimes <christian@python.org>

holzschu referenced this pull request in holzschu/cpython

Nov 23, 2020

Livius90 added a commit to Livius90/cpython that referenced this pull request

Sep 11, 2021

nanjekyejoannah added a commit to nanjekyejoannah/cpython that referenced this pull request

Mar 30, 2022

3: Add warnings for numbers r=vext01 a=nanjekyejoannah

This has several changes, after git playing games with me, I managed to split the commits instead of committing one long one, as I had done before.

*First commit*: Adds warnings for when the suffix "L" is used with numbers but also adds a custom Exception for our work suggested in the review of python#2 , called `Py3xWarning`. I should have committed the exception separately though.
*Second commit*: Add warnings for octal literals. I fixed a test too

Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>

nanjekyejoannah added a commit to nanjekyejoannah/cpython that referenced this pull request

Apr 14, 2022

6: Add warnings for the print statement r=ltratt a=nanjekyejoannah

A Py3k syntax warning has been added for the print statement.

This PR should replace python#2 

Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>

gpshead added a commit that referenced this pull request

Apr 14, 2022

Fix an uninitialized bool in exception print context.
    
`struct exception_print_context.need_close` was uninitialized.
    
Found by oss-fuzz in a test case running under the undefined behavior sanitizer.
    
https://oss-fuzz.com/testcase-detail/6217746058182656
    
```
Python/pythonrun.c:1241:28: runtime error: load of value 253, which is not a valid value for type 'bool'
    #0 0xbf2203 in print_chained cpython3/Python/pythonrun.c:1241:28
    #1 0xbea4bb in print_exception_cause_and_context cpython3/Python/pythonrun.c:1320:19
    #2 0xbea4bb in print_exception_recursive cpython3/Python/pythonrun.c:1470:13
    #3 0xbe9e39 in _PyErr_Display cpython3/Python/pythonrun.c:1517:9
```
    
Pretty obvious what the ommission was upon code inspection.