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.

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

Jump to bottom

Add/improve descriptions #6899

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add/improve descriptions #6899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7cceda3
Add description for RS1025
tmeschter Aug 30, 2023
4369ffb
Add description for RS1026
tmeschter Aug 30, 2023
2f5c019
Fix up resource value
tmeschter Aug 30, 2023
3eff96c
Make a description more informative
tmeschter Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/Microsoft.CodeAnalysis.Analyzers/Core/CodeAnalysisDiagnosticsResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,12 +355,20 @@
<data name="ConfigureGeneratedCodeAnalysisTitle" xml:space="preserve">
<value>Configure generated code analysis</value>
</data>
<data name="ConfigureGeneratedCodeAnalysisDescription" xml:space="preserve">
<value>Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</value>
<comment>Do not localize 'AnalysisContext.ConfigureGeneratedCodeAnalysis'.</comment>
</data>
<data name="EnableConcurrentExecutionMessage" xml:space="preserve">
<value>Enable concurrent execution</value>
</data>
<data name="EnableConcurrentExecutionTitle" xml:space="preserve">
<value>Enable concurrent execution</value>
</data>
<data name="EnabledConcurrentExecutionDescription" xml:space="preserve">
<value>Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</value>
<comment>Do not localize 'AnalysisContext.EnableConcurrentExecution'.</comment>
</data>
<data name="ConfigureGeneratedCodeAnalysisFix" xml:space="preserve">
<value>Configure generated code analysis</value>
</data>
Expand Down Expand Up @@ -548,7 +556,7 @@
<value>Do not use APIs banned for analyzers</value>
</data>
<data name="NoSettingSpecifiedSymbolIsBannedInAnalyzersDescription" xml:space="preserve">
<value>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'.</value>
<value>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'. This will flag the use of APIs that are problematic in analyzers/source generators and should be avoided.</value>
</data>
<data name="NoSettingSpecifiedSymbolIsBannedInAnalyzersMessage" xml:space="preserve">
<value>'{0}': A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'</value>
Expand Down
1 change: 1 addition & 0 deletions ...osoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/ConfigureGeneratedCodeAnalysisAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public class ConfigureGeneratedCodeAnalysisAnalyzer : DiagnosticAnalyzerCorrectn
DiagnosticCategory.MicrosoftCodeAnalysisCorrectness,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(ConfigureGeneratedCodeAnalysisDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
Expand Down
1 change: 1 addition & 0 deletions src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/EnableConcurrentExecutionAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public sealed class EnableConcurrentExecutionAnalyzer : DiagnosticAnalyzerCorrec
DiagnosticCategory.MicrosoftCodeAnalysisCorrectness,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(EnabledConcurrentExecutionDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
Expand Down
14 changes: 12 additions & 2 deletions src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.cs.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@
<target state="translated">Symboly by se měly porovnat podle rovnosti.</target>
<note />
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisDescription">
<source>Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</source>
<target state="new">Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</target>
<note>Do not localize 'AnalysisContext.ConfigureGeneratedCodeAnalysis'.</note>
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisFix">
<source>Configure generated code analysis</source>
<target state="translated">Nakonfigurovat analýzu vygenerovaného kódu</target>
Expand Down Expand Up @@ -202,6 +207,11 @@
<target state="translated">Povolit souběžné provádění</target>
<note />
</trans-unit>
<trans-unit id="EnabledConcurrentExecutionDescription">
<source>Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</source>
<target state="new">Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</target>
<note>Do not localize 'AnalysisContext.EnableConcurrentExecution'.</note>
</trans-unit>
<trans-unit id="InvalidEntryInAnalyzerReleasesFileRuleDescription">
<source>Invalid entry in analyzer release file.</source>
<target state="translated">Neplatná položka v souboru vydané verze analyzátoru</target>
Expand Down Expand Up @@ -298,8 +308,8 @@
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersDescription">
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'.</source>
<target state="translated">Projekt obsahující analyzátory nebo zdrojové generátory by měl určovat vlastnost &lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;.</target>
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'. This will flag the use of APIs that are problematic in analyzers/source generators and should be avoided.</source>
<target state="needs-review-translation">Projekt obsahující analyzátory nebo zdrojové generátory by měl určovat vlastnost &lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;.</target>
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersMessage">
Expand Down
14 changes: 12 additions & 2 deletions src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.de.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@
<target state="translated">Symbole sollten auf Gleichheit verglichen werden</target>
<note />
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisDescription">
<source>Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</source>
<target state="new">Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</target>
<note>Do not localize 'AnalysisContext.ConfigureGeneratedCodeAnalysis'.</note>
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisFix">
<source>Configure generated code analysis</source>
<target state="translated">Konfigurieren der Analyse von generiertem Code</target>
Expand Down Expand Up @@ -202,6 +207,11 @@
<target state="translated">Gleichzeitige Ausführung aktivieren</target>
<note />
</trans-unit>
<trans-unit id="EnabledConcurrentExecutionDescription">
<source>Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</source>
<target state="new">Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</target>
<note>Do not localize 'AnalysisContext.EnableConcurrentExecution'.</note>
</trans-unit>
<trans-unit id="InvalidEntryInAnalyzerReleasesFileRuleDescription">
<source>Invalid entry in analyzer release file.</source>
<target state="translated">Ungültiger Eintrag in Analysetool-Releasedatei.</target>
Expand Down Expand Up @@ -298,8 +308,8 @@
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersDescription">
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'.</source>
<target state="translated">Ein Projekt, das Analysetools oder Quellgeneratoren enthält, muss die Eigenschaft "&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;" angeben.</target>
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'. This will flag the use of APIs that are problematic in analyzers/source generators and should be avoided.</source>
<target state="needs-review-translation">Ein Projekt, das Analysetools oder Quellgeneratoren enthält, muss die Eigenschaft "&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;" angeben.</target>
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersMessage">
Expand Down
14 changes: 12 additions & 2 deletions src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.es.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@
<target state="translated">Se debe comparar la igualdad de los símbolos</target>
<note />
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisDescription">
<source>Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</source>
<target state="new">Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</target>
<note>Do not localize 'AnalysisContext.ConfigureGeneratedCodeAnalysis'.</note>
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisFix">
<source>Configure generated code analysis</source>
<target state="translated">Configurar análisis de código generado</target>
Expand Down Expand Up @@ -202,6 +207,11 @@
<target state="translated">Habilitar la ejecución simultánea</target>
<note />
</trans-unit>
<trans-unit id="EnabledConcurrentExecutionDescription">
<source>Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</source>
<target state="new">Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</target>
<note>Do not localize 'AnalysisContext.EnableConcurrentExecution'.</note>
</trans-unit>
<trans-unit id="InvalidEntryInAnalyzerReleasesFileRuleDescription">
<source>Invalid entry in analyzer release file.</source>
<target state="translated">Entrada no válida en el archivo de versión del analizador.</target>
Expand Down Expand Up @@ -298,8 +308,8 @@
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersDescription">
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'.</source>
<target state="translated">Un proyecto que contenga analizadores o generadores de origen debe especificar la propiedad "&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;".</target>
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'. This will flag the use of APIs that are problematic in analyzers/source generators and should be avoided.</source>
<target state="needs-review-translation">Un proyecto que contenga analizadores o generadores de origen debe especificar la propiedad "&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;".</target>
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersMessage">
Expand Down
14 changes: 12 additions & 2 deletions src/Microsoft.CodeAnalysis.Analyzers/Core/xlf/CodeAnalysisDiagnosticsResources.fr.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@
<target state="translated">La comparaison des symboles doit porter sur l'égalité.</target>
<note />
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisDescription">
<source>Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</source>
<target state="new">Call the 'AnalysisContext.ConfigureGeneratedCodeAnalysis' method to configure the handling of generated code for this analyzer. Non-configured analyzers will default to an appropriate default mode for generated code.</target>
<note>Do not localize 'AnalysisContext.ConfigureGeneratedCodeAnalysis'.</note>
</trans-unit>
<trans-unit id="ConfigureGeneratedCodeAnalysisFix">
<source>Configure generated code analysis</source>
<target state="translated">Configurer l'analyse du code générée</target>
Expand Down Expand Up @@ -202,6 +207,11 @@
<target state="translated">Activer l'exécution simultanée</target>
<note />
</trans-unit>
<trans-unit id="EnabledConcurrentExecutionDescription">
<source>Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</source>
<target state="new">Call the 'AnalysisContext.EnableConcurrentExecution' method to enable concurrent execution of analyzer actions registered by this analyzer. An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer. However, such an analyzer must ensure that its actions can execute correctly in parallel.</target>
<note>Do not localize 'AnalysisContext.EnableConcurrentExecution'.</note>
</trans-unit>
<trans-unit id="InvalidEntryInAnalyzerReleasesFileRuleDescription">
<source>Invalid entry in analyzer release file.</source>
<target state="translated">Entrée non valide dans le fichier de version d'analyseur.</target>
Expand Down Expand Up @@ -298,8 +308,8 @@
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersDescription">
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'.</source>
<target state="translated">Un projet contenant des analyseurs ou des générateurs sources doit spécifier la propriété ' &lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'</target>
<source>A project containing analyzers or source generators should specify the property '&lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'. This will flag the use of APIs that are problematic in analyzers/source generators and should be avoided.</source>
<target state="needs-review-translation">Un projet contenant des analyseurs ou des générateurs sources doit spécifier la propriété ' &lt;EnforceExtendedAnalyzerRules&gt;true&lt;/EnforceExtendedAnalyzerRules&gt;'</target>
<note />
</trans-unit>
<trans-unit id="NoSettingSpecifiedSymbolIsBannedInAnalyzersMessage">
Expand Down