dotnet / dotnet/api-docs-sync

Type docs applied to all partial classes

Abierto
#91 0 comentarios 0 reacciones 0 asignados Ver en GitHub
port-to-tripleslash
Lenguaje dominante
C#
Estrellas
14
Forks
21
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.