Documentation Enhancement
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- clojure
- Área
- documentation
Línea de trabajo
Comienza comparando la función help en src/compojure/api/help.clj con la implementación de ejemplo en src/compojure/api/core.clj y, después, revisa la documentación existente en src/compojure/api/meta.clj. El issue necesita una decisión del maintainer sobre si generar Markdown mediante help o actualizar directamente los docstrings; se considerará terminado cuando se implemente un enfoque acordado y la documentación esté actualizada.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I've been thinking about expanding some of the docstrings, but I'm not sure how is best to go about it.
One option is to just copy the output of the help function but change it to use markdown instead of plain text, I've made a quick sample implementation here. I realise that this copy pasting of documentation makes it harder to keep updated so this option isn't perfect by any means. I also don't think that the documentation in meta has been updated in 2 years so it might not be perfectly up to date but presumably this can be easily fixed (I know that it definitely has one or two spelling mistakes to be fixed).
Another way I could achieve the same effect could be to change the functions in the help namespace to accept an output-type parameter, or something similar, to change the output to generate markdown instead of plain text. This would mean making a code change though and although I don't see the help function used anywhere else in the code, I don't know who else might be using it.
My question here is what do you think would be the best way to make this change? The hope is to eventually submit this as a pull request.
- Lenguaje dominante
- Clojure
- Estrellas
- 1.1k
- Forks
- 145
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 metosin/compojure-api
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
metosin/compojure-api#489 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#468 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
metosin/compojure-api#467 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
metosin/compojure-api#464 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#463 · 3 comentarios ·
Todos los issues de metosin/compojure-api
Issues similares
-
Dificultad 2/5 Medio día Aptitud para principiantes 84/100
clojure-lsp/clojure-lsp#2502 ·
Los mantenedores suelen responder en 1 día
-
Sessions are never closedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
category:tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día