cplusplus / cplusplus/draft

Specification Style Guidelines have some outdated rules

Open
#8,050 2 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

In discussion during code review, some decisions have been pointed out that have not been codified in the guidelines:

  1. The current rule for indentation in itemize doesn't seem accurate. That is:

    \begin{itemize}
    \item
      A B
      C D.
    \end{itemize}
    

    I have indented the library part of reflections like this, believing that the guidelines are correct, but I can see that Jens doesn't bother indenting after \item.

  2. We have a rule to indent two spaces after a template-head, but this allegedly doesn't apply to struct. Some C++26 wording still follows this outdated rule, like:

    template<auto V>
      struct nontype_t {
        explicit nontype_t() = default;
      };
    template<auto V> constexpr nontype_t<V> nontype{};
    

    If this is not what we want, it should be clarified.

@burblebee do you have links to the discussions where these decisions have been made?

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 Specification Style Guidelines wiki page linked in the issue and locate the rules for itemize indentation and indentation after a template-head. Confirm the referenced code-review decisions, then update the guidelines so both examples have an explicit, agreed-upon rule.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.