◐ Shell
reader mode source ↗
Skip to content

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

Merged
ericsnowcurrently merged 9 commits into
python:mainfrom
ericsnowcurrently:interp-module-docs
Jun 30, 2025
Merged

gh-134939: Fill Out the concurrent.interpreters Docs#135902
ericsnowcurrently merged 9 commits into
python:mainfrom
ericsnowcurrently:interp-module-docs

Conversation

@ericsnowcurrently

@ericsnowcurrently ericsnowcurrently commented Jun 24, 2025

Copy link
Copy Markdown
Member

@auvipy auvipy left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hide comment

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

@StanFromIreland

Copy link
Copy Markdown
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

auvipy commented Jun 25, 2025

Copy link
Copy Markdown

Interesting! Didn’t know that to be honest

@ericsnowcurrently

Copy link
Copy Markdown
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
Copy Markdown
Member

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

Copy link
Copy Markdown
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.

Hide details View details @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
Copy Markdown

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 fc82cb9)

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

bedevere-app Bot commented Jun 30, 2025

Copy link
Copy Markdown

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>
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
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