cplusplus / cplusplus/draft

Style for chain-of-"otherwise" itemizations

Open
#5,810 5 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

Reported by @Dani-Hub: We currently use different placements for "otherwise" in itemizations, namely

  • does x if foo,
  • otherwise does y if bar,
  • otherwise does z.

compared to:

  • does x if foo, otherwise
  • does y if bar, otherwise
  • does z.

The first style ("leading-otherwise") seems more popular (?) than the second ("trailing-otherwise"), though I haven't actually counted. If we prefer one style, we should record that in the wiki and fix up the deviant cases.

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 two itemization examples in the issue and inspect the project wiki for existing style guidance. Search the draft for both leading-otherwise and trailing-otherwise cases, then document the preferred style in the wiki and update the deviant cases once the preference is decided.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.