cplusplus / cplusplus/draft

Indentation used in Latex for \items

Open
#3,127 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
221
Forks
813
Avg merge
16h 4m
Merged PRs (30d)
36

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Specification Style Guidelines, then inspect the draft's existing LaTeX \item formatting to identify the inconsistent patterns. Done means applying the agreed whitespace style consistently across the affected text while preserving the document content and structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.