Automatically add boilerplate summary for auto-added parameterless constructors
- Lenguaje dominante
- C#
- Estrellas
- 14
- Forks
- 21
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
[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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Compara las entradas generadas de runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml con los archivos XML correspondientes de dotnet-api-docs para HalfConverter, Int128Converter y UInt128Converter. Investiga si los constructores sin parámetros son generados por el compilador o faltan debido al artifacts path; después, revisa el comportamiento de sincronización y acuerda un resumen genérico. Se considera terminado cuando se haya establecido la causa y se hayan definido el tratamiento del boilerplate y la redacción.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp
- Área
- documentation, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100