-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
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
Conversation
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? |
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. |
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. |
I also prefer one space, but we allow either one or two. This is documented in the devguide for documentation:
And PEP 8 for comments:
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:
The same applies here. And I think such a PR may also mark a lot of translations as outdated, when nothing much has changed. |
📚 Documentation preview 📚: https://cpython-previews--136637.org.readthedocs.build/