Update CA2255 description per documentation team review #5733
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #5733 +/- ##
=======================================
Coverage 96.03% 96.03%
=======================================
Files 1330 1330
Lines 306570 306570
Branches 9722 9722
=======================================
+ Hits 294423 294429 +6
+ Misses 9797 9792 -5
+ Partials 2350 2349 -1 |
buyaa-n
reviewed
Nov 19, 2021
src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/MicrosoftNetCoreAnalyzersResources.resx
Outdated
Show resolved
Hide resolved
Co-authored-by: Buyaa Namnan <buyankhishig.namnan@microsoft.com>
|
@jeffhandley You will need to update the xlf files (rebuilding the solution should be enough). |
Thanks; done! |
Evangelink
reviewed
Jan 22, 2022
| @@ -2114,7 +2114,7 @@ The logging message template should not vary between calls. | |||
|
|
|||
| ## [CA2255](https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2255): The 'ModuleInitializer' attribute should not be used in libraries | |||
|
|
|||
| Module initializers are intended to be used by application code to ensure an application's components are initialized before the application code begins executing. If library code declares a 'ModuleInitializer' method, it can interfere with application initialization and also lead to limitations in that application's trimming abilities. Library code should therefore not utilize the 'ModuleInitializer' attribute, but instead expose methods that can be used to initialize any components within the library and allow the application to invoke the method during application initialization. | |||
| Module initializers are intended to be used by application code to ensure an application's components are initialized before the application code begins executing. If library code declares a method with the 'ModuleInitializerAttribute', it can interfere with application initialization and also lead to limitations in that application's trimming abilities. Library code should therefore not utilize the 'ModuleInitializerAttribute'. Instead of using 'ModuleInitializerAttribute' methods, the library should expose methods that can be used to initialize any components within the library and allow the application to invoke the method during application initialization. | |||
There was a problem hiding this comment.
May I suggest to simplify a little the text to something like:
Module initializers are intended to be used by application code to ensure an application's components are initialized before the application code begins executing. If library code declares a method with the 'ModuleInitializerAttribute', it can interfere with application initialization and also lead to limitations in that application's trimming abilities. Instead of using these methods, the library should expose methods that can be used to initialize any components within the library and allow the application to invoke the method during application initialization.
or
Module initializers are intended to be used by application code to ensure an application's components are initialized before the application code begins executing. If library code declares a method with the 'ModuleInitializerAttribute', it can interfere with application initialization and also lead to limitations in that application's trimming abilities. Instead of using methods marked with 'ModuleInitializerAttribute', the library should expose methods that can be used to initialize any components within the library and allow the application to invoke the method during application initialization.
mavasani
approved these changes
Jan 28, 2022
|
Gosh; this PR completely fell off my radar to finish up. I applied the 2nd suggestion from @Evangelink and resolved the merge conflicts. Once merged, I'll circle back to the docs repo to apply that wording suggestion there too. |
Youssef1313
reviewed
May 2, 2022
|
@jeffhandley Build is failing due to incorrect |
Co-authored-by: Youssef Victor <youssefvictor00@gmail.com>
Thanks! Looks like my merge was done incorrectly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5732, applying wording feedback received while publishing the documentation for this analyzer. dotnet/docs#27096 (review)