Skip to content

Commit a625458

Browse files
committed
added language disclaimer
1 parent 14380dc commit a625458

4 files changed

+8
-2
lines changed

docs/code-quality/ca1701-resource-string-compound-words-should-be-cased-correctly.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ By default, the English (en) version of the spelling checker is used. If you wan
4646
- Use <xref:System.Reflection.AssemblyCultureAttribute> to specify the culture if your resources are in a satellite assembly.
4747
- Use <xref:System.Resources.NeutralResourcesLanguageAttribute> to specify the *neutral culture* of your assembly if your resources are in the same assembly as your code.
4848

49+
> [!IMPORTANT]
50+
> If you set the culture to anything other than an English-based culture, this code analysis rule is silently disabled.
51+
4952
## When to suppress warnings
5053

5154
It is safe to suppress a warning from this rule if both parts of the compound word are recognized by the spelling dictionary and the intent is to use two words.

docs/code-quality/ca1703-resource-strings-should-be-spelled-correctly.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ By default, the English (en) version of the spelling checker is used. If you wan
4444
- Use <xref:System.Reflection.AssemblyCultureAttribute> to specify the culture if your resources are in a satellite assembly.
4545
- Use <xref:System.Resources.NeutralResourcesLanguageAttribute> to specify the *neutral culture* of your assembly if your resources are in the same assembly as your code.
4646

47+
> [!IMPORTANT]
48+
> If you set the culture to anything other than an English-based culture, this code analysis rule is silently disabled.
49+
4750
## When to suppress warnings
4851

4952
Do not suppress a warning from this rule. Correctly spelled words reduce the time that is required to learn new software libraries.

docs/code-quality/ca1704-identifiers-should-be-spelled-correctly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To fix a violation of this rule, correct the spelling of the word or add the wor
6464

6565
### To add words to a custom dictionary
6666

67-
Name the custom dictionary XML file *CustomDictionary.xml*. Place the dictionary in the installation directory of the tool, the project directory, or in the directory that is associated with the tool under the profile of the user (*%USERPROFILE%\Application Data\\...*). To learn how to add the custom dictionary to a project in Visual Studio, see [How to: Customize the Code Analysis Dictionary](../code-quality/how-to-customize-the-code-analysis-dictionary.md)
67+
Name the custom dictionary XML file *CustomDictionary.xml*. Place the dictionary in the installation directory of the tool, the project directory, or in the directory that is associated with the tool under the profile of the user (*%USERPROFILE%\Application Data\\...*). To learn how to add the custom dictionary to a project in Visual Studio, see [How to: Customize the Code Analysis Dictionary](../code-quality/how-to-customize-the-code-analysis-dictionary.md).
6868

6969
- Add words that should not cause a violation under the Dictionary/Words/Recognized path.
7070

docs/code-quality/ca2204-literals-should-be-spelled-correctly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This rule checks a literal string that is passed as a value to a parameter or pr
3737

3838
- The parameter or property name contains "Text", "Message", or "Caption".
3939

40-
- The name of the string variable that is passed to a <xref:System.Console.Write> or <xref:System.Console.WriteLine> method is either "value" or "format".
40+
- The name of the string variable that is passed to a <xref:System.Console.Write%2A> or <xref:System.Console.WriteLine> method is either "value" or "format".
4141

4242
This rule parses the literal string into words, tokenizing compound words, and checks the spelling of each word or token. For information about the parsing algorithm, see [CA1704: Identifiers should be spelled correctly](../code-quality/ca1704-identifiers-should-be-spelled-correctly.md).
4343

0 commit comments

Comments
 (0)