Skip to content

fix(config): non-standard attributes off by default - #1336

Merged
alandefreitas merged 1 commit into
cppalliance:developfrom
alandefreitas:fix/non-standard-attributes-default
Oct 6, 2026
Merged

alandefreitas merged 1 commit into
cppalliance:developfrom
alandefreitas:fix/non-standard-attributes-default

Conversation

@alandefreitas

Copy link
Copy Markdown
Collaborator

This changes one default. MrDocs documented compiler-specific attributes unless a project turned the option off, so the reference of a few Boost libraries, and our own, shows [[__visibility__, __exclude_from_explicit_instantiation__]] on members inherited from the standard library. Export macros and libc++ put those there for the linker, not for a reader. With the option off by default, only the standard C++ attributes appear, and a project that wants the rest turns it on. The change is small, but it is live in Boost documentation builds today, so I would like it in soon.

Changes

The default of the option is now off, and I regenerated the schema from it. Three golden fixtures test compiler-specific attributes on purpose. Each of them now turns the option on, so its output does not change. A project that wants those attributes documented has to turn the option on.

Testing

The golden fixture for the option already runs with it off, which is now the default. The three fixtures above keep the opt-in path under test.

Documentation

I updated the option description in the configuration reference. No other page mentions the default.

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

✨ Highlights

  • 🧪 Existing golden tests changed (behavior likely shifted)

🧾 Changes by Scope

Scope Lines Δ% Lines Δ Lines + Lines - Files Δ Files + Files ~ Files ↔ Files -
🛠️ Source 36% 4 2 2 1 - 1 - -
📄 Docs 36% 4 2 2 1 - 1 - -
🥇 Golden Tests 27% 3 3 - 3 2 1 - -
Total 100% 11 7 4 5 2 3 - -

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

🔝 Top Files

  • docs/modules/ROOT/attachments/schemas/config/mrdocs.schema.json (Docs): 4 lines Δ (+2 / -2)
  • src/mrdocs/ConfigOptions.json (Source): 4 lines Δ (+2 / -2)
  • tests/golden/fixtures/generator/hbs/attributes/mrdocs.yml (Golden Tests): 1 lines Δ (+1 / -0)

Generated by 🚫 dangerJS against ed6d72a

@codecov

codecov Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.12%. Comparing base (917352d) to head (ed6d72a).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1336   +/-   ##
========================================
  Coverage    83.12%   83.12%           
========================================
  Files           35       35           
  Lines         3662     3662           
  Branches       844      844           
========================================
  Hits          3044     3044           
  Misses         410      410           
  Partials       208      208           
Flag Coverage Δ
bootstrap 83.12% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

@cppalliance-bot

cppalliance-bot commented Oct 6, 2026 •

Copy link
Copy Markdown

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

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

2026-10-06 17:08:13 UTC

Comment thread docs/modules/ROOT/attachments/schemas/config/mrdocs.schema.json Outdated
@alandefreitas
alandefreitas disabled auto-merge October 6, 2026 16:30
@alandefreitas
alandefreitas force-pushed the fix/non-standard-attributes-default branch from f16611e to ed6d72a Compare October 6, 2026 16:59
@alandefreitas
alandefreitas added this pull request to the merge queue Oct 6, 2026
Merged via the queue into cppalliance:develop with commit 744b43e Oct 6, 2026
32 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.

3 participants