Skip to content

Enable beman-tidy (--require-all mode) into beman.span - #21

Open
neatudarius wants to merge 3 commits into
mainfrom
neatudarius-patch-1
Open

Enable beman-tidy (--require-all mode) into beman.span#21
neatudarius wants to merge 3 commits into
mainfrom
neatudarius-patch-1

Conversation

@neatudarius

Copy link
Copy Markdown
Member

@coveralls

coveralls commented Jul 13, 2026

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — neatudarius-patch-1 into main

@ssam18
ssam18 marked this pull request as ready for review July 26, 2026 17:49
Enabling --require-all promotes readme.implements and release.godbolt_trunk_version from recommendations to requirements, and neither was satisfied. The Implements line now uses the **Implements**: spelling the check expects and points at a wg21.link paper, and there is a Compiler Explorer badge linking to a runnable example built against beman_span trunk. beman-tidy goes from 94.29% to 100% locally.
@ssam18

ssam18 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Hi @neatudarius, I pushed a small README fix here, CI should go green now.

Turning on --require-all promotes two recommendations into requirements, and both were failing:

  • readme.implements the check wants the exact Implements: spelling (colon outside the bold) and a wg21.link/Pxxxx reference. We had Implements: and only linked cppreference / eel.is.
  • release.godbolt_trunk_version we had no Compiler Explorer badge in the README at all.

With those two fixed, beman-tidy goes from 94.29% to 100% locally.

One thing I would like your call on: I put P2821R5 (span::at()) on the Implements line, since it's the only paper actually cited anywhere in the code (span.hpp). But the library clearly aims at more than that #2 (span over initializer_list) and #4 (tuple protocol for fixed-size spans) are pointing at other proposals. The check happily accepts a comma-separated list of papers, so if you'd rather have several listed there, tell me which and I'll update the line.

Also FYI: the badge points at a Compiler Explorer link I created https://godbolt.org/z/4vsvzbf7z. It builds the README usage example against beman_span trunk on CE and runs clean. Easy to swap for a different snippet if you'd prefer something else there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants