Skip to content
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

Consistency: spacing around em dashes #284

Closed
devreal opened this issue Apr 14, 2020 · 5 comments
Closed

Consistency: spacing around em dashes #284

devreal opened this issue Apr 14, 2020 · 5 comments
Assignees
Labels
editor change Changes to be made by the document editor

Comments

@devreal
Copy link

devreal commented Apr 14, 2020

The use of spaces around em dash is inconsistent:

# without spaces
$ egrep "[a-z]\\-\\-\\-[a-z]" *.tex */*.tex | wc -l
9
# with spaces
$ egrep "[a-z] \\-\\-\\- [a-z]" *.tex */*.tex | wc -l
36

From what I can see, some style manuals recommend no spaces (Chicago Manual of Style, Oxford Guide to Style) but there are others (NYT, AP) that recommend (small) spaces [1]. My personal preference is having no spaces but that might just be acquired taste (for one, space-em dash-space is quite large and line breaks before/after an em dash are ugly imo).

Fun fact: the use is inconsistent even in the instructions document.

In any case, the use of spacing around em dashes should be consistent throughout the standard document and documented in the instructions.

[1] https://en.wikipedia.org/wiki/Dash#Spacing_and_substitution

@wgropp
Copy link

wgropp commented Apr 14, 2020

Good point - thanks for the catch. I'll fix this instructions; for the record, I prefer no spaces but obviously don't check :)

@wgropp
Copy link

wgropp commented Apr 16, 2020

Instructions fixed - no spaces around the em dash.

@martinruefenacht
Copy link

Do we already have a PR to fix the spacing in the document? (Will there be one?)

I think this is another one that would be reasonable to write a test for related to the Python CI PR.

@wgropp
Copy link

wgropp commented Apr 16, 2020

I don't think that we have a PR for this yet - I did just the instructions so I wouldn't forget.

@martinruefenacht
Copy link

I can take this on and additionally write a test for it to enforce it in future.

I assume this would be part of the editor pass?

@martinruefenacht martinruefenacht self-assigned this Apr 16, 2020
@wesbland wesbland added editor change Changes to be made by the document editor editor pass labels Apr 17, 2020
@wesbland wesbland added this to Finished Informal Reading in Editor Pass Status Apr 17, 2020
@wesbland wesbland added this to To Do in MPI 4.0 Ratification Oct 21, 2020
@wgropp wgropp closed this as completed Nov 5, 2020
MPI 4.0 Ratification automation moved this from To Do to Done Nov 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editor change Changes to be made by the document editor
Projects
No open projects
Editor Pass Status
  
Finished Informal Reading
Development

No branches or pull requests

4 participants