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

Indentation used in Latex for \items #3127

Open
burblebee opened this issue Aug 5, 2019 · 7 comments
Open

Indentation used in Latex for \items #3127

burblebee opened this issue Aug 5, 2019 · 7 comments

Comments

@burblebee
Copy link
Contributor

burblebee commented Aug 5, 2019

Our guidelines say to use 2 space indentation for \items which span multiple lines, which I find to be very helpful: it's clear to see where the bullets start and end, and when bullet lists are nested. We're also inconsistent in whether the \items are separated by newlines, and whether the text should start on the same line as the \item. When we edit old text which doesn't use follow our guidelines however, we tend to stick with the old style for consistency, at which rate we'll never move to the new, improved coding style.

Can we do a global whitespace change to fix the old formatting style so that we can follow the guidelines when applying edits?

@burblebee burblebee added the decision-required A decision of the editorial group (or the Project Editor) is required. label Aug 5, 2019
@Eelis
Copy link
Contributor

Eelis commented Aug 5, 2019

(#1899 also concerns a global whitespace policy change involving newlines.)

@jensmaurer
Copy link
Member

Editorial teleconference: No consensus.

@jensmaurer jensmaurer added decision-required A decision of the editorial group (or the Project Editor) is required. and removed decision-required A decision of the editorial group (or the Project Editor) is required. labels Sep 10, 2019
@jensmaurer jensmaurer added this to the C++20 milestone Sep 30, 2019
@jensmaurer
Copy link
Member

See also #2110.

@jensmaurer
Copy link
Member

jensmaurer commented Nov 4, 2019

Editorial meeting: For long \item, add an empty line in front and after.
Do not indent \item. Break after \item unless all of the bullets are very short.
Keep it as rough guidance, don't mass-update the source code.
Update the formatting wiki write-up accordingly.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Nov 4, 2019
@JohelEGP
Copy link
Contributor

Update the formatting wiki write-up accordingly.

Please, do.

@jensmaurer jensmaurer removed this from the C++20 milestone Jan 25, 2020
@burblebee
Copy link
Contributor Author

burblebee commented Feb 14, 2020

Update the formatting wiki write-up accordingly.

Please, do.

Yes please! It's not clear to me what is expected for the long items - fixing the wiki would make this clear. From "For long \item, add an empty line in front and after", we'll have empty lines after the \begin{itemize} and before the \end{itemize}, often resulting in a \begin{itemize} or \end{itemize} statement having an empty line both before and after it which seems odd, is that what we want? Perhaps we should instead have an empty line before the \begin{itemize} (except when starting a paragraph) and after the \end{itemize}? Example:

\pnum
Blah blah blah...
Blah blah:

\begin{itemize}
\item
A multi-line text.

\item
Another multi-line text.
\end{itemize}

Blah blah blah...

Hope folks won't mind if I follow my suggestion until I hear otherwise.

@Eelis
Copy link
Contributor

Eelis commented Feb 15, 2020

Perhaps we should instead have an empty line before the \begin{itemize} (except when starting a paragraph) and after the \end{itemize}

When the list is part of a sentence, inserting empty lines around the list breaks the sentence, which breaks sentence linking on eel.is/c++draft. See #1899.

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