Rename README to README.rst and enhance formatting by vstinner · Pull Request #2 · python/cpython (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation25 Commits1 Checks0 Files changed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
[ Show hidden characters]({{ revealButtonHref }})
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.
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.
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!
| 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.
README.rst Outdated Show resolved Hide resolved
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough :)
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
zware added a commit that referenced this pull request
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).
zooba referenced this pull request in zooba/cpython
zooba referenced this pull request in zooba/cpython
native-api pushed a commit to native-api/cpython that referenced this pull request
Thanks @Mariatta for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!
Sorry, @Mariatta, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker e699b1b7c60b648693cff9a370ab50bff373baeb 3.12
bytemarx added a commit to bytemarx/cpython that referenced this pull request
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.
bytemarx added a commit to bytemarx/cpython that referenced this pull request
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
barneygale added a commit to barneygale/cpython that referenced this pull request
vorfol pushed a commit to vmssoftware/cpython that referenced this pull request
fix: typo in docstring
Approved-by: Sergey Vorfolomeev
This was referenced
Feb 11, 2025