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. |
| 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. |
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.
| 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: |
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. |
|
Thanks @Mariatta for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Sorry, @Mariatta, I could not cleanly backport this to |
|
Thanks @Mariatta for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Sorry, @Mariatta, I could not cleanly backport this to |
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.
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.
fix: typo in docstring Approved-by: Sergey Vorfolomeev
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.