dotnet / dotnet/api-docs-sync

Type docs applied to all partial classes

Open
#91 0 comments 0 reactions 0 assignees View on GitHub
port-to-tripleslash
Dominant language
C#
Stars
14
Forks
21
PR merge metrics
No merged PRs in 30d

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.
![DocsPortingTool](https://user-images.githubusercontent.com/4403806/132305012-f22cd642-7264-41a0-b2c1-bbdeb2d86b8a.gif)

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
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.