cplusplus / cplusplus/draft

[class.prop] standard-layout class type requirements are hard to read

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

Nobody has claimed this yet.

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

Description

I find that https://eel.is/c++draft/class.prop#2.7 is pretty hard to read in its current state: https://github.com/cplusplus/draft/blob/0ca05d2160509f832532469fe8d8b83ead0de922/source/classes.tex#L208-L230

For starters, we can replace the first and last bullet like:

-\item If \tcode{X} is a non-union class type with no non-static data members, 
-the set $M(\mathtt{X})$ is empty. 
 [...]
-\item If \tcode{X} is a non-class, non-array type, the set $M(\mathtt{X})$ is empty.
+Otherwise, the set $M(\mathtt{X})$ is empty.

I may draft up an actual PR for this soon, but I'm still pondering on how to fully simplify this.

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

Read source/classes.tex around lines 208–230 and the [class.prop] paragraph linked in the issue. Compare the proposed consolidation with the remaining bullet wording and determine a complete simplification that preserves the standard’s meaning. Done means the paragraph is easier to read and the source matches the intended wording.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.