Skip to content

Conversation

ghogen
Copy link
Contributor

@ghogen ghogen commented Sep 16, 2023

Fixes #9220

Context

CustomBuildEventArgs is deprecated. Users are advised to use ExtendedCustomBuildEventArgs instead.
See #8917

The comment change results in a public-facing doc change at
https://learn.microsoft.com/en-us/dotnet/api/microsoft.build.framework.custombuildeventargs?view=msbuild-17-netcore

The new Remarks section includes a link to a public-facing doc that explains the change:
https://learn.microsoft.com/en-us/dotnet/core/compatibility/sdk/8.0/custombuildeventargs

Changes Made

Comment only change.
I added the Remarks tag to be explicit. Previously, the double-slash comment was being implicitly treated as the Remarks section. The tag makes this explicit (not necessary but helpful to avoid ambiguity).

I left the existing warning in place in the Remarks section, even though it seems to be intended as an internal comment. This is present throughout the docs and may be good to review / clean up at some point.

Testing

Notes

@rainersigwald rainersigwald added this to the VS 17.8 milestone Sep 18, 2023
Copy link
Member

@baronfel baronfel left a comment

Choose a reason for hiding this comment

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

Let's get the ball rolling on deprecating this one.

@rainersigwald rainersigwald enabled auto-merge (squash) September 21, 2023 19:45
Copy link
Member

@JanKrivanek JanKrivanek left a comment

Choose a reason for hiding this comment

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

Thanks!

@rainersigwald rainersigwald merged commit 9a26a2f into dotnet:main Oct 26, 2023
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.

Add deprecation note to CustomBuildEventArgs

5 participants