Tutorial 'continue.scrbl' signatures rendering confusing to readers
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza con web-server-doc/web-server/scribblings/tutorial/continue.scrbl e inspecciona allí la representación de la signatura; después, lee scribble-lib/scribble/private/manual-proc.rkt para entender el formateo relevante de manuales. Compara el espaciado entre la descripción y la signatura del tutorial con el del ejemplo enlazado; se considera terminado cuando la signatura está asociada visualmente con la descripción precedente y separada del párrafo siguiente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The rendering of signatures in the Continue tutorial is confusing to readers
In the tutorial, functions are often described, then followed by their signature in the familiar scribble/manual format.
Unfortunately the hairline at the top of the signature, in addition to the large gap above, and lack of a gap below gives the impression the signature is associated with the subsequent text.
My suggestion is the rendering of continue is changed to support the 'description followed by signature' style of the text. I'd suggest moving the hairline to the bottom of the signature, and increasing the spacing between the signature and the subsequent paragraph.
Options to resolve;
- a different css stylesheet for continue.scribble
- an new signature function that handles spacing differently
- other options?
https://github.com/racket/scribble/blob/master/scribble-lib/scribble/private/manual-proc.rkt
- Lenguaje dominante
- Racket
- Estrellas
- 100
- Forks
- 48
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 racket/web-server
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
racket/web-server#46 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
racket/web-server#141 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
racket/web-server#140 ·
-
`make-dir-store` is not atomicAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
racket/web-server#135 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
racket/web-server#131 · 1 comentario ·
Todos los issues de racket/web-server
Issues similares
-
changelog investigate
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
ramnes/notion-sdk-py#409 ·
-
Broken links in the docsAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
salesforce/multicloudj#667 ·
Los mantenedores suelen responder en 1 día
-
bug needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
End of term: remove the PerfForesightCRRA-Approximation stub, and redirect its econ-ark.org pageAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 2 días
-
Bug pulumi/pulumi
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día