classification
Title: Double Spaces in the documentation
Type: Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, matrixise, mdk, seluj78
Priority: normal Keywords:

Created on 2019-05-09 11:54 by seluj78, last changed 2019-05-09 14:15 by mdk. This issue is now closed.

Messages (2)
msg341977 - (view) Author: Jules Lasne (seluj78) * Date: 2019-05-09 11:54
Hello,

I've come to open this issue today because of the apparent split there is in the documentation about double spaces after a period.

Here is a link to an article explaining some of the issue
https://www.writing-skills.com/one-space-two-full-stop

Anyway, the opinion isn't really important here but, when translating the documentation we waste a lot of time removing the double spaces that are ugly and useless in French.

I'd like to propose a PR to remove all double spaces after a period from the documentation as they serve no apparent purpose.

I'm open for discussion of course
msg341979 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2019-05-09 14:15
Some people are liking the double space thing. Some are not.

It's in the documentation style guide [1] and there's arond 20k use of it.

I don't think we want to change it: modifing 18900 lines in the docs will make most opened PRs conflict, we don't want that. Also it'll pollute git blame a lot. Also it'll mark most translations as fuzzy in all languages, nobody want that.

You say it costs you time removing them from the translation, just don't remove them, and if you don't like them nobody will complain if you're not typing them both while translating.

[1]: https://devguide.python.org/documenting/#use-of-whitespace
History
Date User Action Args
2019-05-09 14:15:44mdksetstatus: open -> closed
resolution: wont fix
messages: + msg341979

stage: resolved
2019-05-09 12:11:18seluj78setnosy: + matrixise, mdk
2019-05-09 11:54:49seluj78create