<see langword="..."/> renders as nothing in API docs
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- fsharp
- Área
- documentation
Línea de trabajo
Empieza por el tratamiento de see y seealso en src/FSharp.Formatting.ApiDocs/XmlDocReader.fs, en las líneas 193–213. Comprueba cómo gestiona el lector cref y cómo los elementos c se convierten en código en línea; después, sigue los tests pertinentes de la documentación de la API. La tarea estará completa cuando valores de langword como true se muestren como código en línea en lugar de desaparecer.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
XmlDocReader renders a <see> or <seealso> element only when it has a cref attribute (XmlDocReader.fs#L193-L213). <see langword="true"/>, the .NET way to reference a keyword, has no cref, so the word is lost: /// <summary>Returns <see langword="true"/> when the event has at least one handler.</summary> renders as "Returns when the event has at least one handler." The expected output is the keyword as inline code, the same as <c>true</c>.
FSharp.Core starts to use langword in dotnet/fsharp#20940, so its API reference shows the gap.
- Lenguaje dominante
- F#
- Estrellas
- 492
- Forks
- 160
- Merge medio
- 3 d 14 h
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de fsprojects/FSharp.Formatting
-
enhancement help wanted
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
fsprojects/FSharp.Formatting#1064 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
fsprojects/FSharp.Formatting#929 · 8 comentarios · 13 reacciones ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
fsprojects/FSharp.Formatting#928 · 18 comentarios ·
Los mantenedores suelen responder en 1 día
-
Nesting Document CategoriesQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertoenhancement needs-community-interest
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
fsprojects/FSharp.Formatting#927 · 7 comentarios ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
fsprojects/FSharp.Formatting#898 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de fsprojects/FSharp.Formatting
Issues similares
-
bug documentation
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
apify/apify-docs#3206 ·
Los mantenedores suelen responder en 1 día
-
docs size:S
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
zerohourzulu/irontrellis#16 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
Droid-Deck/DroidDeck#2198 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
better-auth/better-auth#12292 · 1 reacción ·
Los mantenedores suelen responder en 1 día