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

A fix to the use of <remark> tags rather than <remarks> in the documentation comments #1776

Merged

Conversation

AlissaSabre
Copy link
Contributor

@AlissaSabre AlissaSabre commented Aug 24, 2024

This PR fixes #1775

  • by fixing the code generator (commit a7c4f6d), and
  • by fixing two non-generated source files (commit f0d1c08).

The changes to the generated source files (i.e., those in generated/) are not included in this PR, because they will be re-generated by the updated code generator when building. (You will need to commit those changes to the repository by yourself...)
The changes to the generated source files are now included in the PR in commit 7e08714 for easier review.

Note that, for the purpose of testing the behavior of the patched generator, you will need to do the following:

  • After applying this PR to your working tree, you may need to restart Windows and run dotnet clean, then remove all files in (subdirectories of) generated/ manually before running dotnet build.

@AlissaSabre
Copy link
Contributor Author

AlissaSabre commented Aug 24, 2024

I have read the Contribution License Agreement. I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for any of my past employers.
@dotnet-policy-service agree

(Note that I am not employed by anybody at the moment, looking for a new job... :)

@twsouthwick
Copy link
Member

Thanks @AlissaSabre. Can you commit the changes to the generated code? We persist those so we can see what the changes are - yeah, it makes for a larger change anytime you make a change there, but it's proven helpful to see the impact.

@AlissaSabre
Copy link
Contributor Author

AlissaSabre commented Aug 27, 2024

@twsouthwick
Sure. Here you are.

Thank you for checking!

Copy link
Member

@twsouthwick twsouthwick left a comment

Choose a reason for hiding this comment

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

Thanks!

@twsouthwick twsouthwick enabled auto-merge (squash) August 28, 2024 16:48
@twsouthwick
Copy link
Member

After applying this PR to your working tree, you may need to restart Windows and run dotnet clean, then remove all files in (subdirectories of) generated/ manually before running dotnet build.

What you're getting at here is probably that VS (or any long lived roslyn process) doesn't reload analyzers/generators/code fixers. I've never had to restart Windows - restarting VS is usually sufficient. Also, removing the generated/ directory shouldn't matter as it isn't used for compilation and will be overwritten (there is a ci step that verifies that the files there match what the compiler is emitting).

Copy link

Test Results

    70 files      70 suites   1h 0m 36s ⏱️
 2 033 tests  2 030 ✅  3 💤 0 ❌
32 322 runs  32 286 ✅ 36 💤 0 ❌

Results for commit 7e08714.

Copy link
Collaborator

@mikeebowen mikeebowen left a comment

Choose a reason for hiding this comment

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

LGTM

@twsouthwick twsouthwick merged commit 29b0f44 into dotnet:main Oct 8, 2024
22 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.

Some source files use <remark> tags rather than <remarks> in their documentation comments
3 participants