Skip to content

Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute triple slash to docs #7102

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 8, 2021
Merged

Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute triple slash to docs #7102

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e0127b
Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute tripl…
carlossanlop Sep 3, 2021
3f568e1
suggestion by pgovind
carlossanlop Sep 3, 2021
5d86010
add link
carlossanlop Sep 3, 2021
c142d84
Apply suggestions from code review
carlossanlop Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions xml/System.Runtime.Versioning/RequiresPreviewFeaturesAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that an API is in preview. This attribute allows call sites to be flagged with a diagnostic that indicates that a preview feature is used. Authors can use this attribute to ship preview features in their assemblies.</summary>
<remarks>To be added.</remarks>
Copy link
Contributor Author

@carlossanlop carlossanlop Sep 3, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

[Suggestion removed, I placed this in the wrong line. See the next line]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note: The link is not active yet, but will be by the time we ship.

Copy link
Contributor

Choose a reason for hiding this comment

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

Change to type="Article"? Also, who is writing the documentation?

Copy link
Contributor Author

@carlossanlop carlossanlop Sep 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@pgovind @tannergooding are you going to take care of this document? It should be up before we ship this: https://aka.ms/dotnet-warnings/preview-features

Copy link
Contributor

Choose a reason for hiding this comment

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

I've added the preview features properties to the MSBuild reference: https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#enablepreviewfeatures. But I'll also plan to write a conceptual article.

<related type="Article" href="https://aka.ms/dotnet-warnings/preview-features">Preview Features</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -57,8 +58,8 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<param name="message">An optional message associated with this attribute instance.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute" /> class with the specified message.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -78,7 +79,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the optional message associated with this attribute instance.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -99,7 +100,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the optional URL associated with this attribute instance.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down