Skip to content

Commit ab440ef

Browse files
Copilot fixed grammar in the md file
1 parent a149b2f commit ab440ef

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/list-of-diagnostics.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# List of Diagnostics Produced by Windows Forms .NET
22

3-
We have 3 kinds of diagnostic messages: obsoletions, code analyzer diagnostics, and experimental feature compiler errors.
3+
We have three kinds of diagnostic messages: obsoletions, code analyzer diagnostics, and experimental feature compiler errors.
44

55
## Obsoletions
66

@@ -11,12 +11,12 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
1111
### Acceptance Criteria for Adding an Obsoletion
1212

1313
1. **Add the obsoletion to the table below**, claiming the next diagnostic ID.
14-
- Ensure the description is meaningful within the context of this table, and without requiring the context of the calling code.
14+
- Ensure the description is meaningful within the context of this table and without requiring the context of the calling code.
1515
2. **Add new constants to `src\Common\src\Obsoletions.cs`**, following the existing conventions:
1616
- A `...Message` const using the same description added to the table below.
1717
- A `...DiagnosticId` const for the `WFDEV###` ID.
18-
3. **If adding `<Obsolete>` attribute to Microsoft.VisualBasic.Forms assembly**, edit `src\Microsoft.VisualBasic.Forms\src\Obsoletions.vb` file.
19-
4. **Annotate `src` files by referring to the constants defined from `Obsoletions.cs`**:
18+
3. **If adding the `<Obsolete>` attribute to the Microsoft.VisualBasic.Forms assembly**, edit the `src\Microsoft.VisualBasic.Forms\src\Obsoletions.vb` file.
19+
4. **Annotate `src` files by referring to the constants defined in `Obsoletions.cs`**:
2020
- Specify the `UrlFormat = Obsoletions.SharedUrlFormat`.
2121
- Example:
2222
```C#
@@ -30,15 +30,15 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
3030
<Compile Include="..\..\Common\src\Obsoletions.cs" Link="Common\Obsoletions.cs" />
3131
```
3232
5. **Create the new `aka.ms` link**
33-
- Point it to repo's `.md` file in the `docs` folder that describes your analyzer until the `learn` site docs are completed in the [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home)
34-
- Set security group to the team alias
33+
- Point it to the repo's `.md` file in the `docs` folder that describes your analyzer until the `learn` site docs are completed in the [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home)
34+
- Set the security group to the team alias
3535
6. **Apply the `:book: documentation: breaking` label** to the PR that introduces the obsoletion.
3636
7. **Document the breaking change**
3737
- In the breaking-change issue filed in [dotnet/docs](https://github.com/dotnet/docs), specifically mention that this breaking change is an obsoletion with a `WFDEV` diagnostic ID.
38-
- Create another issue to add documentation to the `learn` web site [in dotnet/docs-desktop repo](https://github.com/dotnet/docs-desktop/issues/new?template=diagnostic-compiler.yml)
39-
- The documentation team will produce a PR that adds the warning or error documentation to the ["learn" site](https://learn.microsoft.com/dotnet/desktop/winforms/wfdev-diagnostics/wfdev003) page and we will review it.
40-
- Once the docs PR is published, get the newly created link to the doc and associate it with the corresponding `aka.ms` name in [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home?options=host:aka.ms )
41-
- Connect with `@gewarren`, `@adegeo` or `@merriemcgaw` with any questions.
38+
- Create another issue to add documentation to the `learn` website in the [dotnet/docs-desktop repo](https://github.com/dotnet/docs-desktop/issues/new?template=diagnostic-compiler.yml)
39+
- The documentation team will produce a PR that adds the warning or error documentation to the [`learn` site](https://learn.microsoft.com/dotnet/desktop/winforms/wfdev-diagnostics/wfdev003) page, and we will review it.
40+
- Once the docs PR is published, get the newly created link to the doc and associate it with the corresponding `aka.ms` name in the [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home?options=host:aka.ms)
41+
- Connect with `@gewarren`, `@adegeo`, or `@merriemcgaw` with any questions.
4242

4343
### Obsoletion Diagnostics (`WFDEV001` - `WFDEV999`)
4444

@@ -60,16 +60,16 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
6060
| `WFDEV006` | NET10.0 | `StatusBar` is provided for binary compatibility with .NET Framework and is not intended to be used directly from your code. Use `StatusStrip` instead. |
6161
| `WFDEV006` | NET10.0 | `ToolBar` is provided for binary compatibility with .NET Framework and is not intended to be used directly from your code. Use `ToolStrip` instead. |
6262

63-
## Analyzer Diagnostics.
63+
## Analyzer Diagnostics
6464

6565
### When adding a new analyzer
6666

6767
1. **Add the diagnostic ID to the table below**.
68-
- The current IDs for C#, VB and language-agnostic analyzers are defined in [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). Complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
69-
- Starting in NET9.0, we are using `WFO####` format for code analyzer diagnostic IDs.
70-
2. **Create a new Descriptor** in the analyzer code using [DiagnosticDescriptorHelper.Create](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers.CSharp/src/System/Windows/Forms/CSharp/Analyzers/Diagnostics/DiagnosticDescriptorHelper.cs#L10)
71-
- this method will generate the help link in https://aka.ms/winforms-warnings/WFO#### format.
72-
3. **Follow [documentation steps 5-7 described for obsoletions](#create-the-new-aka.ms-link)** above.
68+
- The current IDs for C#, VB, and language-agnostic analyzers are defined in [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). A complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
69+
- Starting in NET9.0, we are using the `WFO####` format for code analyzer diagnostic IDs.
70+
2. **Create a new Descriptor** in the analyzer code by calling [DiagnosticDescriptorHelper.Create](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers.CSharp/src/System/Windows/Forms/CSharp/Analyzers/Diagnostics/DiagnosticDescriptorHelper.cs#L10)
71+
- This method will generate the help link in the https://aka.ms/winforms-warnings/WFO#### format.
72+
3. **Follow the [documentation steps 5-7 described for obsoletions](#create-the-new-aka.ms-link)** above.
7373

7474
| Diagnostic ID | Introduced | Description |
7575
| :-------------| :--------- | :---------- |
@@ -85,19 +85,19 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
8585
| `WFO2001` | NET9.0 | Task is being passed to `InvokeAsync` without a cancellation token |
8686
| `WFO1001` | NET10.0 | Type `{0}` does not implement `ITypedDataObject` interface |
8787

88-
## Experimental Feature compiler errors
88+
## Experimental Feature Compiler Errors
8989

9090
See [Preview APIs - .NET | Microsoft Learn](https://learn.microsoft.com/dotnet/fundamentals/apicompat/preview-apis) for more information.
9191
Documentation for experimental features is available in the [Experimental Help](https://github.com/dotnet/winforms/blob/main/docs/analyzers/Experimental.Help.md) file.
9292
9393
1. **Add the diagnostic ID to the table below**.
94-
- The current IDs for C#, VB and language-agnostic analyzers are defined in [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). Complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
94+
- The current IDs are defined in [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs).
9595
2. **Add an `[Experimental](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute)` attribute** to your API.
9696
- Example:
9797
```c#
9898
[Experimental(DiagnosticIDs.ExperimentalDarkMode, UrlFormat = DiagnosticIDs.UrlFormat)]
9999
```
100-
3. **Follow [documentation steps 5-7 described for obsoletions](#create-the-new-aka.ms-link)** above.
100+
3. **Follow the [documentation steps 5-7 described for obsoletions](#create-the-new-aka.ms-link)** above.
101101

102102
| Diagnostic ID | Introduced | Removed | Description |
103103
| :------------ | :--------- | :------ | :---------- |

0 commit comments

Comments
 (0)