Enums are not documented
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
Empieza leyendo los comentarios de la interfaz en src/main.ts y comparándolos con el README actual. Documenta todos los elementos de src/main.ts, incluidos los valores permitidos para SyntaxKind y NodeType. La tarea estará terminada cuando el README cubra la interfaz completa, en lugar de obligar a los lectores a inspeccionar src/.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The only documentation for this library appears to be the README. However, this documentation is incomplete. The README documentation references several "enum-type" types, such as SyntaxKind (an enum{}) or NodeType (a union type supporting seven strings). Without knowing the allowed values of these enums, the library is not usable.
Clicking around in the github repo, I found src/main.ts, an extremely readable file with comments documenting the entire interface including the enums. I was able to use this to write my code. However a less experienced coder might not think to look for documentation in the src/ folder.
Expected behavior
All items from src/main.ts should be included in the README documentation, including the enums.
- Lenguaje dominante
- TypeScript
- Estrellas
- 759
- Forks
- 66
- Merge medio
- 6 d 19 h
- PR fusionados (30 d)
- 5
Preparar el entorno
Aún no hemos revisado los archivos de configuración de este proyecto. 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 microsoft/node-jsonc-parser
-
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
microsoft/node-jsonc-parser#125 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
microsoft/node-jsonc-parser#105 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
microsoft/node-jsonc-parser#103 · 2 comentarios · 8 reacciones ·
-
Provide usage examplesAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
microsoft/node-jsonc-parser#97 · 3 reacciones ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
microsoft/node-jsonc-parser#95 · 1 reacción ·
Todos los issues de microsoft/node-jsonc-parser
Issues similares
-
Add: Digi World (Romania) SDAbiertocheck:passed streams:add
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Fission-AI/OpenSpec#1986 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
nestjs/docs.nestjs.com#3554 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
publicodes/publicodes#868 ·
-
namespace operations
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
EclipseFdn/open-vsx.org#13488 ·
Los mantenedores suelen responder en 2 días