cplusplus / cplusplus/draft

[basic.compound] Weird and conflicting uses of `defnx`

Open Beginner friendly
#9,282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

https://github.com/cplusplus/draft/blob/c7015b485cc3db8efaa9dfb9ff0809c5394a4ed1/source/basic.tex#L5950-L5957

There is no logic to these uses of defnx in https://eel.is/c++draft/basic.compound.

This intro fluff paragraph is really just a note that summarizes the various forms of forming compound types; it doesn't define anything and so all the uses of defnx should probably be removed here.

What's even more problematic is that it breaks the spec by having multiple definitions of the same term, such as

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 in source/basic.tex at lines 5950-5957 and inspect how the defnx uses render in basic.compound. Compare the paragraph with the separate union definition in class.union.general. Done means the introductory paragraph no longer creates conflicting term definitions while still summarizing compound types accurately.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.