dotnet / dotnet/api-docs-sync

Type docs applied to all partial classes

Ouverte
#91 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
port-to-tripleslash
Langage dominant
C#
Étoiles
14
Forks
21
Métriques de merge des PR
Aucune PR mergée en 30 j

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Examinez comment l'outil traite Application.cs et les autres fichiers Application.*.cs listés dans l'issue, en commençant par la logique actuelle de documentation des types et de déduplication. Vérifiez qu'un type n'est annoté qu'une seule fois et que la déduplication sélectionne le nom de fichier le plus court, avec Application.cs privilégié dans l'exemple.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp
Domaine
documentation, tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.