Skip to content

Conversation

@vstinner
Copy link
Member

@vstinnervstinner commented Feb 10, 2017

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.

@vstinner
Copy link
MemberAuthor

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

@zware
Copy link
Member

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

``./configure --help`` 

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

@vstinner
Copy link
MemberAuthor

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

@refi64refi64 mentioned this pull request Feb 10, 2017
Copy link
Member

@zwarezware left a comment

Choose a reason for hiding this comment

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

A couple of minor things, but mostly looks good!

README.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
MemberAuthor

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.

README.rst Outdated
Copy link
Member

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/>`_. 

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Ditto.

Update also the Release Schedule to Python 3.7.
@codecov
Copy link

codecovbot commented Feb 11, 2017

Codecov Report

❗ No coverage uploaded for pull request base (master@4538ddc). Click here to learn what that means.

@@ Coverage Diff @@## master #2 +/- ## ========================================= Coverage ? 82.37% ========================================= Files ? 1427 Lines ? 350948 Branches ? 0 ========================================= Hits ? 289087 Misses ? 61861 Partials ? 0

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 4538ddc...a44be7d. Read the comment docs.

@vstinner
Copy link
MemberAuthor

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

@zwarezware left a comment

Choose a reason for hiding this comment

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

Fair enough :)

@vstinnervstinner merged commit d783b01 into python:masterFeb 11, 2017
@vstinnervstinner deleted the README branch February 11, 2017 01:21
@vstinner
Copy link
MemberAuthor

And the winner is .... http://www.python.org/dev/peps/pep-0537 => HTTP link. But since each change now requires a PR, I'm not interested to write a PR just to replace HTTP with HTTPS :-p

@zware
Copy link
Member

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

@Mariatta
Copy link
Member

Do we want to backport this to 3.5 and 2.7?

@vstinner
Copy link
MemberAuthor

vstinner commented Feb 25, 2017 via email

@Mariatta
Copy link
Member

Thanks @Haypo . I saw the messages in http://bugs.python.org/issue29579. Seems like we won't be backporting readme changes to 3.5 and 2.7.
I'll remove the labels.

bytemarx added a commit to bytemarx/cpython that referenced this pull request Dec 10, 2023
Hijacked the interpreter state to get my boys on the inside. Currently, there doesn't seem to be an officially supported way to get a piece of pre-initialized per-interpreter memory over to an embedded module (more specifically, the embedded module's functions). For example: [init'd mem python#1] ----> [subinterp python#1] ---->{module fn call} [init'd mem python#2] ----> [subinterp python#2] ---->{module fn call}{module fn call} has a single implementation with access to its module state via `PyModule_GetState`. The initialization of a subinterpreter populates a custom entry for the pre-initialized memory in its interpreter state. On initialization of the embedded module (`Py_mod_exec`), the module state is populated with the custom entry (`PyThreadState_Get()->interp`). The module function now has access to the pre-initialized memory via its module state.
barneygale added a commit to barneygale/cpython that referenced this pull request Jan 8, 2024
barneygale added a commit to barneygale/cpython that referenced this pull request Oct 29, 2024
vorfol pushed a commit to vmssoftware/cpython that referenced this pull request Dec 16, 2024
fix: typo in docstring Approved-by: Sergey Vorfolomeev
@AmitSahaAmitSahamannequin mentioned this pull request Apr 10, 2022
DinoV referenced this pull request in DinoV/cpython Oct 9, 2025
sharktide added a commit to sharktide/cpython that referenced this pull request Nov 16, 2025
SonicField added a commit to SonicField/cpython that referenced this pull request Jan 19, 2026
Add timing for all intermediate GC phases to diagnose the 50-80ms gap between timed phases and total gc.collect() time. New timing fields: - scan_heap_ns: parallel scan_heap phase - disable_deferred_ns: disable deferred refcounting loop - find_weakrefs_ns: find_weakref_callbacks - stw1_ns: StartTheWorld python#1 - objs_decref_ns: cleanup_worklist(objs_to_decref) - weakref_callbacks_ns: call_weakref_callbacks - finalize_ns: finalize_garbage - stw2_ns: StopTheWorld python#2 - resurrection_ns: handle_resurrected_objects - freelists_ns: _PyGC_ClearAllFreeLists - clear_weakrefs_ns: clear_weakrefs - stw3_ns: StartTheWorld python#3 All values exposed via gc.get_parallel_stats()['phase_timing'].
Sign up for freeto 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.

8 participants

@vstinner@zware@Mariatta@miss-islington@mariatta-bot@dstufft@merwok@the-knights-who-say-ni