cplusplus / cplusplus/draft

Consistent vertical spacing for access modifiers in [ranges]

Open
#4,704 11 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

We currently often don't have any blank lines between private: and public: parts, especially in [ranges].

We're also inconsistent between class X { stuff; and class X { private: stuff;.

I propose the following, to be added to the editorial wiki:

  • Always make access specifiers explicit when the class key is class. If a private section is needed at the beginning, that means we say class { private:.
  • Always separate access sections with a blank line.

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 editorial wiki guidance referenced in the issue and inspect the [ranges] material for the current access-specifier formatting. Done means the wiki records the proposed convention and the relevant [ranges] examples follow the documented spacing and explicit-specifier rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.