dotnet / dotnet/api-docs-sync

Automatically add boilerplate summary for auto-added parameterless constructors

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

Description

[HalfConverter](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/HalfConverter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34), [Int128Converter ](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/Int128Converter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34)or [UInt128Converter](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/UInt128Converter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34), have their documentation xml file created in this location:

runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml

None of these 3 APIs have an xml entry for a parameterless constructor, but it gets added to the dotnet-api-docs file automatically anyway. According to [this programming guide doc](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/instance-constructors#parameterless-constructors), it's valid.

To fix this:

- We need to agree on a generic boilerplate message that would apply to all APIs. Something like:

> `Creates a new instance with default values.`

- We need investigate if it’s possible to determine if a parameterless constructor was autogenerated by the compiler and that’s why I was unable to find its docs in the intellisense xml files, or if the problem was that the user provided the wrong artifacts path which does not contain the xml file with that type’s docs.

Guide de contribution

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

Piste de recherche

Comparez les entrées générées de runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml avec les fichiers XML correspondants de dotnet-api-docs pour HalfConverter, Int128Converter et UInt128Converter. Déterminez si les constructeurs sans paramètre sont générés par le compilateur ou s’ils sont absents en raison de l’artifacts path, puis examinez le comportement de synchronisation et convenez d’un résumé générique. La tâche est terminée lorsque la cause est établie et que la gestion du boilerplate ainsi que la formulation sont définies.

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

Évaluation

Stack technique
csharp
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 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.