electron / electron/docs-parser
multi-mode Class description error
- Vorherrschende Sprache
- TypeScript
- Sterne
- 29
- Forks
- 19
- Ø Merge
- 5 Std. 31 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, das Parsing-Verhalten im Multi-Mode anhand des im Issue verlinkten Beispiels zu reproduzieren, und verfolge dann, wie Klassenbeschreibungen bis zum ersten Konstruktor gesammelt werden. Als abgeschlossen gilt die Aufgabe, wenn jede Klasse nur ihre eigene Beschreibung behält, einschließlich Klassen ohne Konstruktor, ohne dass eine übermäßig große zusammengeführte Zeichenkette erzeugt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100