electron / electron/docs-parser

multi-mode Class description error

Abierto
#27 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
29
Forks
19
Merge medio
5 h 31 min
PR fusionados (30 d)
2

Descripción

It seems that there is currently a bug when packageMode is `multi` that nullifies descriptions of each class into a rather excessively large string.

Specifically, it seems that it starts at the first description in the document and ends at the first constructor it encounters. If there are no constructors, it leaves it empty.

Here's an example (`querystring` and `Worker Threads` properties can be ignored): https://gist.github.com/bnb/bcc9394cfd81bd61ffdb9b3d303b799b

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza reproduciendo el comportamiento de análisis en varios modos usando el ejemplo enlazado en el issue y, después, sigue cómo se recopilan las descripciones de las clases hasta el primer constructor. Se considera completado cuando cada clase conserva únicamente su propia descripción, incluidas las clases sin constructor, sin producir una cadena combinada excesivamente grande.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation, tooling
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.