Skip to content

Restore the operator listings and drop the unneeded exemptions - #391

Merged
Bronek merged 1 commit into
mainfrom
bronek/fix_docs_error
Aug 1, 2026
Merged

Restore the operator listings and drop the unneeded exemptions#391
Bronek merged 1 commit into
mainfrom
bronek/fix_docs_error

Conversation

@Bronek

@Bronek Bronek commented Aug 1, 2026

Copy link
Copy Markdown
Member

docs has been red on main since the TYPE_ALGEBRA merge, which gates the Pages deploy — the published site stays stale until this lands.

The last commit on that PR's branch (ee0fbd35) took both docs checks red, and neither of its two stated goals holds:

  • The reference listings were not stale. docs_check_signatures validates them against the doxygen XML of the real headers, and it passed on the preceding commit. The change dropped four operator& overloads — the short-circuit arms -> std::remove_cvref_t<Rh> and -> std::remove_cvref_t<Lh>, which appear in the expected and the optional group alike — and operator|'s -> ::fn::just<void> arm, duplicating four some_optional entries in their place.
  • docs_check_coverage did not need satisfying: it was already passing. The six added exemptions name entities the check reaches, and it reports each one as unnecessary.

This restores the three files to their state before that commit, byte for byte.

Verified locally: export_docs exits 0 through all six steps, docs_check_coverage and docs_check_signatures included.

No new test is owed — the behaviour is gated by those two checks, which are what caught the regression.

Assisted-by: Claude:claude-opus-5

Reverts ee0fbd3, which took both docs checks red. The listings were not
stale: docs_check_signatures validates them against the headers' doxygen XML
and passed on the commit before. It dropped four `operator&` overloads — the
short-circuit arms, in the expected and the optional group alike — and
`operator|`'s `just<void>` arm, duplicating four `some_optional` entries in
their place; the six added exemptions name entities the coverage check already
reaches, which it reports as unnecessary.

Assisted-by: Claude:claude-opus-5
@augmentcode

augmentcode Bot commented Aug 1, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR fixes the docs CI gate by restoring the generated/reference operator listings and removing coverage exemptions that were added unnecessarily.

Changes:

  • Drops six no-longer-needed entries from docs/coverage-exemptions.txt.
  • Restores the full documented overload set for fn::operator& (including the short-circuit return-type arms) in docs/reference/conjoin.md.
  • Restores the documented overload set for fn::operator| (including the ::fn::just<void> arm) in docs/reference/disjoin.md.

Technical Notes: Intended to make docs_check_signatures and docs_check_coverage pass again so Pages deploy can proceed.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

@sonarqubecloud

sonarqubecloud Bot commented Aug 1, 2026

Copy link
Copy Markdown

@Bronek
Bronek merged commit 4d6b3f5 into main Aug 1, 2026
5 checks passed
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.

1 participant