cplusplus / cplusplus/draft

Harmonize wording for format-spec syntax used by different formatter specializations

Open
#6,063 0 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

From LWG telecon discussion ...

[format.string.std]:

The syntax of format specifications is as follows:

[format.range.formatter]:

range_­formatter interprets format-spec as a range-format-spec. The syntax of format specifications is as follows:

[time.format]:

The parse member functions of these formatters interpret the format specification as a chrono-format-spec according to the following syntax

LWG didn't really like the phrasing of "The syntax of format specifications is as follows:", but also didn't like the redundancy in "The parse member functions of these formatters interpret ..." (that is implied in the fact it's a format-spec).

Maybe we could use something that keeps the best bits of each style, e.g. "interprets format-spec as a foo-format-spec, according to the following syntax"

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

Locate the [format.string.std], [format.range.formatter], and [time.format] sections in the draft sources and compare how each describes its format-spec syntax. Choose wording that harmonizes the three descriptions while preserving their distinct format-spec names; done means the affected clauses use consistent phrasing.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.