Rename README to README.rst and enhance formatting #2
Conversation
|
I checked if the "README" file was referenced directly somewhere: I only found Makefile.pre.in. |
|
This could use some additional formatting enhancement, such as changing things like 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. |
zware
left a comment
zware
left a comment
There was a problem hiding this comment.
A couple of minor things, but mostly looks good!
README.rst
Outdated
There was a problem hiding this comment.
We could link to the actual file (https://github.com/python/cpython/blob/master/PCbuild/readme.txt).
There was a problem hiding this comment.
Such change are out of the scope of my initial change. I suggest to make more enhancements in a second change.
README.rst
Outdated
There was a problem hiding this comment.
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/>`_.
Update also the Release Schedule to Python 3.7.
Codecov Report
@@ Coverage Diff @@
## master #2 +/- ##
=========================================
Coverage ? 82.37%
=========================================
Files ? 1427
Lines ? 350948
Branches ? 0
=========================================
Hits ? 289087
Misses ? 61861
Partials ? 0Continue to review full report at Codecov.
|
|
Ok, it seems like Eric and Zach want :pep: 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. |
|
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 |
|
I'd recommend to report that as a bug to Github :). It is at least redirected to https automatically. |
Includes GH-2, pythonGH-70, pythonGH-73, and pythonGH-21.
|
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).
|
|
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. |
fix: typo in docstring Approved-by: Sergey Vorfolomeev
Highlight lazy imports in the new REPL
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'].
8 participants
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.