cpython icon indicating copy to clipboard operation
cpython copied to clipboard

gh-134939: Fill Out the concurrent.interpreters Docs

Open ericsnowcurrently opened this issue 6 months ago • 5 comments

  • Issue: gh-134939

📚 Documentation preview 📚: https://cpython-previews--135902.org.readthedocs.build/

ericsnowcurrently avatar Jun 24 '25 20:06 ericsnowcurrently

@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.

StanFromIreland avatar Jun 25 '25 08:06 StanFromIreland

Interesting! Didn’t know that to be honest

auvipy avatar Jun 25 '25 08:06 auvipy

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.

ericsnowcurrently avatar Jun 25 '25 15:06 ericsnowcurrently

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 avatar Jun 27 '25 16:06 ericsnowcurrently

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

miss-islington-app[bot] avatar Jun 30 '25 16:06 miss-islington-app[bot]

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

bedevere-app[bot] avatar Jun 30 '25 16:06 bedevere-app[bot]