Add a documentation class instead of a formatted string.
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
Línea de trabajo
No se nombran archivos ni pruebas. Empieza rastreando dónde se definen, analizan y consumen las cadenas de documentación de las funciones; identifica los campos codificados actualmente en el formato. Se considera terminado cuando la documentación está representada mediante una clase con campos como descripción, tipo de retorno, argumentos y nombre, todos los consumidores existentes están actualizados y cubiertos por las pruebas relevantes del proyecto.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
CMDHELPER-2915 - Reported by ACzChef
Right now functions have to pass in a string for their docs, that then later gets parsed into usable data.
My suggestion is to have a documentation class where you just define all the fields such as description, return type, arguments, name, etc. and use that instead. It would be cleaner, and less error prone.
- Lenguaje dominante
- Java
- Estrellas
- 128
- Forks
- 70
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 EngineHub/CommandHelper
-
discussion wanted documentation
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
EngineHub/CommandHelper#1403 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
EngineHub/CommandHelper#1370 · 1 comentario ·
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
EngineHub/CommandHelper#1354 ·
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
EngineHub/CommandHelper#1349 · 3 comentarios ·
-
bug
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
EngineHub/CommandHelper#1341 · 2 comentarios ·
Todos los issues de EngineHub/CommandHelper
Issues similares
-
certification
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
[BUG] ECR GetAuthorizationToken returns a proxyEndpoint for the default region, not the request's Abiertobug ecr
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Needs: Triage Type: Feature request
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
AntennaPod/AntennaPod#8794 ·
-
agentic-workflows
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
github/copilot-sdk#2760 ·