dotnet / dotnet/api-docs-sync

Don't indent remarks

Abierto
#84 1 comentario 0 reacciones 0 asignados Ver en GitHub
port-to-docs
Lenguaje dominante
C#
Estrellas
14
Forks
21
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

When remarks get indented by 4 spaces, they're rendered as code blocks. For example, [this PR](https://github.com/dotnet/dotnet-api-docs/pull/7054/files) introduced indentation that caused the remarks to render as code blocks. A customer fixed that in https://github.com/dotnet/dotnet-api-docs/pull/7104. The /// for the remarks is [here](https://github.com/dotnet/runtime/blob/36b6247cc7743dda997e9d671175ddc2b3e030ba/src/coreclr/System.Private.CoreLib/src/System/Runtime/DependentHandle.cs#L15) - perhaps the `` tags are causing the indentation.

Guía de contribución

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

Línea de trabajo

Compara los PRs enlazados 7054 y 7104 con los comentarios de triple barra en DependentHandle.cs y, después, sigue la conversión de api-docs-sync que gestiona las etiquetas y la indentación. Se considera completado cuando los comentarios ya no adquieren una indentación de cuatro espacios y se renderizan como bloques de código.

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
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.