Skip to content

feat: render dependent noexcept specifications as noexcept(see-below)#1180

Open
gennaroprota wants to merge 1 commit intocppalliance:developfrom
gennaroprota:feat/describe_noexcept_conditions_naturally
Open

feat: render dependent noexcept specifications as noexcept(see-below)#1180
gennaroprota wants to merge 1 commit intocppalliance:developfrom
gennaroprota:feat/describe_noexcept_conditions_naturally

Conversation

@gennaroprota
Copy link
Copy Markdown
Collaborator

@gennaroprota gennaroprota commented Apr 22, 2026

MrDocs used to render the full noexcept operand inline, so a declaration like

void swap(reference, reference) noexcept(
  std::is_nothrow_move_constructible<value_t>::value &&
  std::is_nothrow_move_assignable<value_t>::value &&
  std::is_nothrow_move_constructible<json_value>::value &&
  std::is_nothrow_move_assignable<json_value>::value);

buried the noexcept condition in a mostly-unreadable slop.

This replaces dependent operands with an italic "see-below" placeholder in the declaration, and moves the actual condition to a dedicated "noexcept Specification" section of the exposition:

void swap(reference, reference) noexcept(see-below);

=== noexcept Specification
noexcept when `...long condition...`.

The section is intentionally separate from the existing "Exceptions" section, which continues to cover @throws documentation.

Closes issue #1103.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 22, 2026

🚧 Danger.js checks for MrDocs are experimental; expect some rough edges while we tune the rules.

✨ Highlights

  • 🧪 Existing golden tests changed (behavior likely shifted)

🧾 Changes by Scope

Scope Lines Δ% Lines Δ Lines + Lines - Files Δ Files + Files ~ Files ↔ Files -
🥇 Golden Tests 79% 747 747 - 17 4 13 - -
🛠️ Source 17% 163 68 95 17 2 15 - -
🏗️ Build 2% 21 19 2 1 - 1 - -
🧪 Unit Tests 1% 12 6 6 1 - 1 - -
Total 100% 943 840 103 36 6 30 - -

Legend: Files + (added), Files ~ (modified), Files ↔ (renamed), Files - (removed)

🔝 Top Files

  • test-files/golden-tests/symbols/function/noexcept.xml (Golden Tests): 226 lines Δ (+226 / -0)
  • test-files/golden-tests/symbols/function/noexcept.html (Golden Tests): 151 lines Δ (+151 / -0)
  • test-files/golden-tests/symbols/function/noexcept.adoc (Golden Tests): 118 lines Δ (+118 / -0)

Generated by 🚫 dangerJS against 4fa1508

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.89%. Comparing base (0246935) to head (7ee2a4e).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1180      +/-   ##
===========================================
+ Coverage    78.85%   81.89%   +3.03%     
===========================================
  Files          308       33     -275     
  Lines        32157     2983   -29174     
  Branches      6456      691    -5765     
===========================================
- Hits         25359     2443   -22916     
+ Misses        4436      373    -4063     
+ Partials      2362      167    -2195     
Flag Coverage Δ
bootstrap 81.89% <ø> (ø)
cpp ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@gennaroprota gennaroprota force-pushed the feat/describe_noexcept_conditions_naturally branch 2 times, most recently from 1e52e6d to 7ee2a4e Compare April 22, 2026 15:04
@cppalliance-bot
Copy link
Copy Markdown

cppalliance-bot commented Apr 22, 2026

An automated preview of the documentation is available at https://1180.mrdocs.prtest2.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-04-23 08:24:03 UTC

MrDocs used to render the full `noexcept` operand inline, so a
declaration like

    void swap(reference, reference) noexcept(
      std::is_nothrow_move_constructible<value_t>::value &&
      std::is_nothrow_move_assignable<value_t>::value &&
      std::is_nothrow_move_constructible<json_value>::value &&
      std::is_nothrow_move_assignable<json_value>::value);

buried the `noexcept` condition in a mostly-unreadable slop.

This replaces dependent operands with an italic "see-below" placeholder
in the declaration, and moves the actual condition to a dedicated
"noexcept Specification" section of the exposition:

    void swap(reference, reference) noexcept(see-below);

    === noexcept Specification
    noexcept when `...long condition...`.

The section is intentionally separate from the existing "Exceptions"
section, which continues to cover `@throws` documentation.

Closes issue cppalliance#1103.
@gennaroprota gennaroprota force-pushed the feat/describe_noexcept_conditions_naturally branch from 7ee2a4e to 4fa1508 Compare April 23, 2026 08:18
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.

2 participants