Use long dash

[serhiy-storchaka]

BPO	18529
Nosy	@birkenfeld, @ezio-melotti, @merwok, @bitdancer, @serhiy-storchaka
Files	doc_mdashes_without_spaces.patch doc_mdashes_with_spaces.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-10-06.09:20:14.279>
created_at = <Date 2013-07-22.13:23:53.147>
labels = ['type-feature', 'docs']
title = 'Use long dash'
updated_at = <Date 2013-12-24.17:37:50.956>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2013-12-24.17:37:50.956>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-10-06.09:20:14.279>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2013-07-22.13:23:53.147>
creator = 'serhiy.storchaka'
dependencies = []
files = ['31005', '31006']
hgrepos = []
issue_num = 18529
keywords = ['patch']
message_count = 5.0
messages = ['193532', '193533', '193755', '199058', '206908']
nosy_count = 7.0
nosy_names = ['georg.brandl', 'ezio.melotti', 'eric.araujo', 'r.david.murray', 'docs@python', 'python-dev', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = 'patch review'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18529'
versions = ['Python 3.4']

[serhiy-storchaka]

Currently Python documentation uses four type of dashes for same meaning:

1. Hyphen with spaces.
2. En-dash with spaces.
3. Em-dash with spaces.
4. Em-dash without spaces.

Definitely the first case is just wrong and other three cases should be unified. Here is a patch which replaces spaced hyphens, en-dashes and em-dashes to em-dashes without spaces.

See also a discussion at Python-Dev:

http://mail.python.org/pipermail/python-dev/2013-July/thread.html#127420
http://comments.gmane.org/gmane.comp.python.devel/140593

[serhiy-storchaka]

Here is an alternative patch which replaces spaced hyphens and en-dashes and non-spaced em-dashes to em-dashes with spaces.

[merwok]

This looks like the kind of high-churn, low-benefit patches that we typically encourage new contributors not to do. It’s fine to update dashes when modifying the surrounding text for another fix, and it may be useful to encourage using them in the markup docs, but not to do one big change.

[birkenfeld]

Agreed.

[python-dev]

New changeset 01d2c25a6804 by R David Murray in branch 'default':
Use endash in PEP callouts.
http://hg.python.org/cpython/rev/01d2c25a6804