Improve readability in framework documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza examinando la documentación generada del módulo del framework y su configuración de Scribblings, usando la captura de pantalla enlazada como contexto. Determina cómo deberían distinguirse los límites entre clases o interfaces y los nombres de métodos repetidos; se considerará terminado cuando la documentación generada separe claramente cada tipo y siga siendo fácil de buscar.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I've been looking forward to step up in my racket journey and start making more complex programs, yet I've been deter from using (most parts of) the framework module because of what appears to be a bug or bad configuration (or most likely a scribblings limitation) in the doc generation.
you can (not) see where a class (or interface) ends and where other starts, and since many method names are repeated it gets confusing to search, since everything is flat.
I would like to help, but I wouldn't really now how, I open this issue in hope that this could make the library easier to use.
- Lenguaje dominante
- Racket
- Estrellas
- 68
- Forks
- 83
- Merge medio
- 21 h
- PR fusionados (30 d)
- 1
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin 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 racket/gui
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de racket/gui
Issues similares
-
agent-research agent-review-finding chore
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
jordansmall/spindrift#4922 ·
Los mantenedores suelen responder en 1 día
-
docs(types): update the collection binding note now that typed collections shipped in pycubrid 1.9.0Abiertodocumentation priority: low size: S
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
cubrid-lab/sqlalchemy-cubrid#768 ·
Los mantenedores suelen responder en 1 día
-
Broken link in index.rstAbiertodocumentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
ansys/pydpf-core#3547 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OktoLabsAI/okto-pulse#113 ·
Los mantenedores suelen responder en 1 día
-
Messenger
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
symfony/symfony-docs#23237 ·
Los mantenedores suelen responder en 3 días