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

Indicate which APIs are annotated with the RequiresPreviewFeatures attribute #6861

Open
jeffhandley opened this issue Jul 3, 2021 · 7 comments
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. Pri1 Indicates issues/PRs that are high priority

Comments

@jeffhandley
Copy link
Member

With the introduction of the [RequiresPreviewFeatures] attribute, we should introduce a mechanism for ensuring that attribute shows up on APIs within the documentation. Each API annotated as such should point to a central documentation page discussing the implications of opting into preview features (and how to do so).

/cc @terrajobst

Originally posted by @tannergooding in dotnet/core#6417 (comment)

@dotnet-bot dotnet-bot added the untriaged New issue has not been triaged by the area owner label Jul 3, 2021
@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@eiriktsarpalis eiriktsarpalis added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Aug 2, 2021
@PRMerger17 PRMerger17 added the Pri3 Indicates issues/PRs that are low priority label Aug 5, 2021
@gewarren gewarren added Pri1 Indicates issues/PRs that are high priority and removed Pri3 Indicates issues/PRs that are low priority labels Oct 18, 2021
@mimisasouvanh
Copy link

Internal item opened.

@jeffhandley jeffhandley removed the untriaged New issue has not been triaged by the area owner label Jan 5, 2022
@terrajobst
Copy link
Member

Any chance we can prioritize this in the .NET 8 timeframe?

The desire to use preview APIs across multiple products is growing. We might also highlight themAPIs in the VS experience as well but having a warning banner in the docs is still important.

@mimisasouvanh
Copy link

FYI @kexugit

@terrajobst
Copy link
Member

terrajobst commented Aug 18, 2023

@mimisasouvanh @gewarren @BillWagner

It looks like this was implemented for [RequiresPreviewFeatures]. Example. We should have a similar experience for [Experimental].

@mimisasouvanh
Copy link

@kexugit should I open a customer suggestion?

@gewarren
Copy link
Contributor

I logged https://dev.azure.com/ceapex/Engineering/_workitems/edit/892618 for ExperimentalAttribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. Pri1 Indicates issues/PRs that are high priority
Projects
None yet
Development

No branches or pull requests

7 participants