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

Comment out ellipses when they mean "more code here" rather than an actual ellipsis token. #1390

Closed
Eelis opened this issue Jan 19, 2017 · 5 comments
Assignees

Comments

@Eelis
Copy link
Contributor

Eelis commented Jan 19, 2017

Most places already do this, but a few don't:

Interestingly, there are also a couple uses of mega-ellipses consisting of five dots (.....):

But maybe these are fine, because at least ..... is not the C++ ellipsis token.

@jensmaurer
Copy link
Member

Patch welcome.

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Feb 15, 2018
@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 18, 2018
@zygoloid
Copy link
Member

  1. A code-font ... looks too much like the actual C++ ... token. As we start accepting that in more places, this is going to get more and more confusing. Commenting them out seems preferable.

  2. /* ... */ is formatted very differently from // ...; the former remains in code font whereas the latter automatically transitions to roman italic typeface. We should investigate whether we can make listings do that for /* ... */ comments too, and whether that looks better.

  3. The ..... mega-ellipses should be excised. These should be center dots for horizontal lists and vertical dots for vertical lists.

@zygoloid
Copy link
Member

It would also be interesting to investigate using \vdots for places where we currently use commented-out ellipses.

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 18, 2018 via email

@tkoeppe
Copy link
Contributor

tkoeppe commented Apr 14, 2018

@zygoloid: I'd like to revise item 3: ellipses should not just blanketly be "center dots", but rather, they should be the appropriate kind of dots for the things they apply to: center dots for binary operators like +, baseline dots for comma-separates items, etc. AmsTex has dedicated commands \dotsc (comma) and \dotsb (binary operator) for that; I think we should follow the same approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants