classification
Title: Remove the double spaces in the C-API Intro
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, georg.brandl, matrixise, serhiy.storchaka, vstinner
Priority: low Keywords: patch

Created on 2015-09-22 12:18 by matrixise, last changed 2015-09-22 17:23 by georg.brandl. This issue is now closed.

Files
File name Uploaded Description Edit
remove_double_space_capi.patch matrixise, 2015-09-22 12:18 review
Messages (12)
msg251310 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-09-22 12:18
Remove the double spaces in the C-API intro in the documentation.
msg251311 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2015-09-22 12:25
Thanks for your contribution, however double spaces after a full stop should be kept, since they are intentional (they make the .rst source more readable).  Your patch also seems to include other instances that are not after a full stop.  In theory those could be kept, but I'm not sure if it's worth spending time preparing and applying a new patch.
msg251312 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-09-22 12:32
Hi Ezio,

What's a full stop ?

Thanks
msg251313 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-09-22 12:34
ok, found: http://www.edufind.com/english-grammar/period-full-stop-or-point/
msg251314 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2015-09-22 12:36
The `.` at the end of a sentence.

In the following example, the double space between "is" and "an" could be fixed (even though is not a big problem), whereas the one between "example." and "This" is OK and should be kept:

This is  an example.  This too.
       ^^           ^^
     Not OK         OK
msg251315 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-09-22 13:02
And in this case:

“This is  an example.  This too”   will become “This is an 
example.  This too”

Is it right?
Stef
On 22 Sep 2015, at 14:36, Ezio Melotti wrote:

> Ezio Melotti added the comment:
>
> The `.` at the end of a sentence.
>
> In the following example, the double space between "is" and "an" could 
> be fixed (even though is not a big problem), whereas the one between 
> "example." and "This" is OK and should be kept:
>
> This is  an example.  This too.
>    ^^           ^^
>  Not OK         OK
>
> ----------
>
> _______________________________________
> Python tracker <report@bugs.python.org>
> <http://bugs.python.org/issue25212>
> _______________________________________
msg251316 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2015-09-22 13:06
The vim editor *adds* two spaces between a full stop and the beginning of a new sentence. As a french, I was always distributed by this, but it's correct in english :-) As Ezio wrote, it may even be better to have two spaces than one, for readability.

Well well well, this issue is really border line because users don't read the .rst files but the HTML output which uses a single space.

Seriously, why really cares? Just close the issue as WONTFIX and try to enhance the doc differently ;-)
msg251317 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2015-09-22 13:07
If you would like to contribute to the Python doc, please help to make the asyncio doc simpler for new comers. Maybe add a few more examples. Or explain better asyncio concepts like tasks, coroutines and futures.
msg251318 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2015-09-22 13:25
PEP 8: You should use two spaces after a sentence-ending period.
msg251319 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2015-09-22 13:29
PEP 9: You must adhere to the Emacs convention of adding two spaces at the end of every sentence.
msg251320 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-09-22 13:32
ok, can I close this useless issue ?

Thank you for the details about the emacs convention and the rest.
msg251333 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2015-09-22 17:23
> As a french, I was always distributed by this, but it's correct in english :-)

You know what you have to tell LaTeX to not put extra space after all full stops? \frenchspacing :)
History
Date User Action Args
2015-09-22 17:23:36georg.brandlsetnosy: + georg.brandl
messages: + msg251333
2015-09-22 14:25:04ezio.melottisetstage: resolved
2015-09-22 14:16:44matrixisesetstatus: open -> closed
resolution: wont fix
2015-09-22 13:32:07matrixisesetmessages: + msg251320
2015-09-22 13:29:03serhiy.storchakasetmessages: + msg251319
2015-09-22 13:25:10serhiy.storchakasetnosy: + serhiy.storchaka
messages: + msg251318
2015-09-22 13:07:29vstinnersetmessages: + msg251317
2015-09-22 13:06:30vstinnersetnosy: + vstinner
messages: + msg251316
2015-09-22 13:02:46matrixisesetmessages: + msg251315
2015-09-22 12:36:25ezio.melottisetmessages: + msg251314
2015-09-22 12:34:17matrixisesetmessages: + msg251313
2015-09-22 12:32:45matrixisesetstatus: pending -> open

messages: + msg251312
2015-09-22 12:25:38ezio.melottisetstatus: open -> pending
priority: normal -> low

nosy: + ezio.melotti
messages: + msg251311

type: enhancement
2015-09-22 12:18:16matrixisecreate