Skip to content

Consistent spacing is a pre-requisite to consistently good writing. #136637

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

Closed
wants to merge 2 commits into from

Conversation

hunterhogan
Copy link
Contributor

@hunterhogan hunterhogan commented Jul 13, 2025

@picnixz
Copy link
Member

picnixz commented Jul 13, 2025

While I agree that double-spaces after a period is somehow outdated nowadays, it's still used by active core devs. This commit also broke (at least) one RST table and double spaces aren't different from single ones when rendering the docs.

Now, surprsingly, there aren't that many differences, so I'm almost tempted to say that I'm neutral on this change if we do it once and for all. However, considering I couldn't find anything forbidding double spaces after a period in the devguide, I think this won't be accepted.

cc @hugovk

@picnixz picnixz added the pending The issue will be closed if no feedback is provided label Jul 13, 2025
@hunterhogan
Copy link
Contributor Author

While I agree that double-spaces after a period is somehow outdated nowadays, it's still used by active core devs. This commit also broke (at least) one RST table and double spaces aren't different from single ones when rendering the docs.

Now, surprsingly, there aren't that many differences, so I'm almost tempted to say that I'm neutral on this change if we do it once and for all. However, considering I couldn't find anything forbidding double spaces after a period in the devguide, I think this won't be accepted.

cc @hugovk

Is there anything in the dev guide about being condescending, dismissive, or making pronouncements about fields in which you are not an expert?

@picnixz
Copy link
Member

picnixz commented Jul 13, 2025

being condescending, dismissive, or making pronouncements about fields in which you are not an expert?

Please, tell me where I was condescending or dismissive. This wasn't my intention. However, it is a fact that we don't accept purely cosmetic PRs and this PR is purely cosmetic. We have an editorial board which decides how the docs should be written, but before pinging them, I asked Hugo for his opinion on this specific matter.

@skirpichev
Copy link
Contributor

I'm closing this on a ground of purely cosmetic changes. If we adopt "one space" style over "two space" (yes, I'm from the camp of emacs users) - this should be documented first in the developer docs and (preferably) enforced by some tool.

@skirpichev skirpichev closed this Jul 14, 2025
@skirpichev skirpichev removed the pending The issue will be closed if no feedback is provided label Jul 14, 2025
@hugovk
Copy link
Member

hugovk commented Jul 14, 2025

I also prefer one space, but we allow either one or two. This is documented in the devguide for documentation:

A sentence-ending period may be followed by one or two spaces. While reST ignores the second space, it is customarily put in by some users, for example to aid Emacs’ auto-fill mode.

And PEP 8 for comments:

You should use one or two spaces after a sentence-ending period in multi-sentence comments, except after the final sentence.

PEP 8 used to require two spaces but was changed fairly recently to allow either one or two, and their was agreement in the discussion that we don't want PRs just to remove spaces:

I’m fine with removing this recommendation as long as we don’t condemn two spaces. We don’t want to encourage a barrage of “remove extra space per PEP 8” PRs. The devguide wording is fine.

The same applies here. And I think such a PR may also mark a lot of translations as outdated, when nothing much has changed.

@hunterhogan hunterhogan deleted the doc-c-api branch July 14, 2025 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy