dotnet / dotnet/api-docs-sync

PortToDocs changing many docs which aren't touched by intellisense input

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

Descripción

It seems to be trying to copy the docs from the interface and/or inheritdoc target.

It shouldn't do this, since it duplicates the doc content. If a member has inheritdoc already the docs build will automatically copy the docs. If a member implements an interface then we can add inheritdoc to opt-in to this.

Guía de contribución

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

Línea de trabajo

Comienza localizando el punto de entrada PortToDocs y reproduce el caso en el que se copia documentación de interface o inheritdoc a pesar de no estar en la entrada de IntelliSense. Rastrea qué miembros se seleccionan para los cambios y verifica que el comportamiento existente de inheritdoc siga delegándose en la compilación de docs. El trabajo estará terminado cuando ya no se modifiquen miembros no relacionados y las implementaciones de interface solo cambien cuando se añada inheritdoc explícitamente.

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
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.