Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Include [Experimental] attribute support by default #10566

Merged
merged 2 commits into from
Mar 3, 2025

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Feb 26, 2025

This PR intended to fix issue #10552

outputFormat: ApiPage supports ExperimentalAttribute (It's identified by name)
And render HTML with Preview badge with alert text.
Example: https://dotnet.github.io/docfx/seed/apipage/BuildFromProject.Class1.html

But when using System.Diagnostics.CodeAnalysis.ExperimentalAttribute attribute.
It's filtered out by default filterconfig settings.
Because when namespace is excluded. all types inside namespace are also excluded.

This PR modify defaultfilterconfig.yml rules and enable ExperimentalAttribute by default.

@filzrev
Copy link
Contributor Author

filzrev commented Feb 26, 2025

Following snapshot file diffs seems be caused by PR(#10113)

test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json

@filzrev filzrev force-pushed the fix-experimental-attribute-filter branch from 97dc9f3 to b1d0481 Compare February 26, 2025 09:46
Copy link
Contributor

@yufeih yufeih left a comment

Choose a reason for hiding this comment

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

Thank you @filzrev

@yufeih yufeih added the bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note label Mar 3, 2025
@yufeih yufeih merged commit 1a1c1e0 into dotnet:main Mar 3, 2025
10 checks passed
@filzrev filzrev deleted the fix-experimental-attribute-filter branch March 3, 2025 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants