Skip to content

gh-134939: Fill Out the concurrent.interpreters Docs #135902

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

Merged
merged 9 commits into from
Jun 30, 2025

Conversation

ericsnowcurrently
Copy link
Member

@ericsnowcurrently ericsnowcurrently commented Jun 24, 2025

Copy link

@auvipy auvipy left a comment

Choose a reason for hiding this comment

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

I'm not sure if the double spaces were intended or not. so suggested some edits....

@StanFromIreland
Copy link
Member

@auvipy I presume Eric is using emacs, the double spaces are fine and conform to many technical writing style guides IIRC. You will find many occurrences throughout out the docs.

@auvipy
Copy link

auvipy commented Jun 25, 2025

Interesting! Didn’t know that to be honest

@ericsnowcurrently
Copy link
Member Author

Using double space between sentences is fairly standard. Traditionally the practice was meant to introduce a stronger visual separation between sentences, to help readers identify the boundary. Using a single space is a relatively recent practice, one that reflects an assumption that the software which renders (lays out) the text, like a browser, will render the inter-sentence boundary sufficiently distinctly. However, in my experience that isn't what actually happens most of the time. (Plus, the same software could just as easily detect the double space and render it how it likes.) Furthermore, text editors in particular don't necessarily follow this practice. For example, I use a fixed-width font in my terminal. Ultimately, any time the the text is rendered naively this way, it presents a readability challenge. Thus, I avoid using a single space between sentences.

@StanFromIreland
Copy link
Member

Traditionally

Very, historically started when type writers where introduced :-)

Comment on lines +21 to +22
Running mostly involves switching to an interpreter (in the current
thread) and calling a function in that execution context.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like a reference to the "Runtime Components" section after #135944 is landed, regarding the OS thread?

Copy link
Member Author

Choose a reason for hiding this comment

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

Places like these are a large part of why I opened that issue. 😄

* :class:`float`
* :class:`tuple` (of similarly supported objects)

There is a small number of Python types that actually share mutable
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There is a small number of Python types that actually share mutable
There are a small number of Python types that actually share mutable

Copy link
Member Author

Choose a reason for hiding this comment

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

The subject of the verb is "a small number", which is singular. Otherwise, I'd agree that "There are Python types that..." would be correct.

Co-authored-by: neonene <53406459+neonene@users.noreply.github.com>
@ericsnowcurrently
Copy link
Member Author

Unless there are any major objections, I'd like to land this today;, I have a "multiple interpreters HOWTO" branch, on top of this change, that I want to put up for review. If there are little things to tweak, I think we can take care of that in a follow-up PR.

@ericsnowcurrently ericsnowcurrently merged commit fc82cb9 into python:main Jun 30, 2025
25 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jun 30, 2025
@miss-islington-app
Copy link

Thanks @ericsnowcurrently for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@ericsnowcurrently ericsnowcurrently deleted the interp-module-docs branch June 30, 2025 16:54
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 30, 2025
…135902)

(cherry picked from commit fc82cb91ba262275fd91bc249ed891afce60f24a)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 30, 2025

GH-136141 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jun 30, 2025
ericsnowcurrently added a commit that referenced this pull request Jun 30, 2025
(cherry picked from commit fc82cb9, AKA gh-135902)

Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants