dotnet / dotnet/api-docs-sync

Missing item in dotnet-api-docs removes the existing item in triple slash

Abierto
#163 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

Example:

```
PortToTripleSlash.exe \
-Docs $ENV:SOURCEREPOS\dotnet-api-docs\xml
-CsProj $ENV:SOURCEREPOS\runtime\src\libraries\Microsoft.Extensions.Hosting.WindowsServices\src\Microsoft.Extensions.Hosting.WindowsServices.csproj
-IncludedAssemblies Microsoft.Extensions.Hosting.WindowsServices
-IncludedNamespaces Microsoft.Extensions.Hosting.WindowsServices
```

One inheritdoc is removed:
![image](https://user-images.githubusercontent.com/1175054/232940039-7a3622dd-a6d3-4af9-a2bf-84afe3407c65.png)

As well as a param:
![image](https://user-images.githubusercontent.com/1175054/232940074-22cb671c-68f8-4cba-be08-ca18076cca83.png)

Guía de contribución

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

Línea de trabajo

Comienza ejecutando el comando PortToTripleSlash.exe del issue contra el proyecto Microsoft.Extensions.Hosting.WindowsServices y el XML de dotnet-api-docs. Compara los comentarios triple-slash generados con la documentación existente, centrándote en los elementos inheritdoc y param eliminados. Se considera completado cuando los elementos XML que faltan ya no eliminan los elementos triple-slash existentes.

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
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.