multi-mode Class description error
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation, tooling
Research direction
Start by reproducing the multi-mode parsing behavior using the example linked in the issue, then trace how class descriptions are collected until the first constructor. Done means each class retains only its own description, including classes with no constructor, without producing an excessively large combined string.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- TypeScript
- Stars
- 29
- Forks
- 19
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from electron/docs-parser
-
:beetle: bug
Difficulty 3/5 1-2 days Newbie friendliness 30/100
electron/docs-parser#84 · 1 comment ·
All issues in electron/docs-parser
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
TanStack/tanstack.com#1293 ·