-
Notifications
You must be signed in to change notification settings - Fork 6k
Docs for CA2252 #26149
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
Docs for CA2252 #26149
Conversation
docs/fundamentals/code-analysis/quality-rules/usage-warnings.md
Outdated
Show resolved
Hide resolved
<PropertyGroup> | ||
<EnablePreviewFeatures>true</EnablePreviewFeatures> | ||
</PropertyGroup> | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you actually mean to delete the ``` here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, this must be a GitHub bug. The actual suggestion is to indent the ``` by two spaces.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gewarren Using backticks inside backticks don't always work well. Whenever I do suggestions involving backticks I use:
~~~suggestion
suggestion containing ``` here
~~~
instead of
```suggestion
suggestion containing ``` here
```
The following is using ~~~suggestion
instead of ``````````suggestion`
``` | |
``` |
Just in case you come across this in future, it has bothered me for long before I knew about the ~~~
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's awesome, thanks @Youssef1313 !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's the preview if you want to take a look: https://review.docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2252?branch=pr-en-us-26149
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with all of @gewarren's suggestions. Assuming those get applied, I have no other feedback. 👍
@pgovind We should include a section about the side effects of This might have helped with dotnet/aspnetcore#36783 (comment). |
I do have a reference section for both of the MSBuild properties. Maybe you can expand those sections and then link to it? https://docs.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#enablepreviewfeatures |
The markdown leg failure here is unrelated. I made a change to msbuild-props.md in the latest commit. It;s a minor change, should be an easy review. |
Thanks for the ping, I'll merge this now. |
Documentation for CA2252 behavior. Followed instructions from https://docs.microsoft.com/en-us/contribute/dotnet/dotnet-contribute-code-analysis. Hopefully I got the grammar/formatting rules right!
cc @jeffhandley @terrajobst