Type docs applied to all partial classes
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation, tooling
Research direction
Review how the tool handles the Application.cs and other Application.*.cs files listed in the issue, starting with the current type-documentation and deduplication logic. Verify that a type is annotated only once and that deduplication selects the shortest filename, with Application.cs preferred in the example.
Written by the indexing model from the issue text.
Description
https://github.com/dotnet/winforms has multiple types that span across multiple files. The tool is currently applying type xmldocs to all partial definitions.
Instead we should track whether a type has been annotated, and not annotate other partials. When deduping we should perhaps look for the file with the shortest name, e.g. from the following list pick Application.cs:
src/System.Windows.Forms/src/System/Windows/Forms/Application.ComponentManager.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.MarshallingControl.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ModalApplicationContext.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ParkingWindow.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ThreadContext.cs
src/System.Windows.Forms/src/System/Windows/Forms/Application.ThreadWindows.cs
- Dominant language
- C#
- Stars
- 14
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/api-docs-sync
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
dotnet/api-docs-sync#182 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
dotnet/api-docs-sync#181 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dotnet/api-docs-sync#180 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dotnet/api-docs-sync#179 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
dotnet/api-docs-sync#178 · 1 comment ·
All issues in dotnet/api-docs-sync
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nightscout/nocturne#1425 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
RayWangQvQ/BiliBiliToolPro#1137 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100