Bullet lists incorrectly take precedence over explicit `Returns <type>`

Open
#84 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
typescript
Domain
tooling

Research direction

Start with the linked Electron issue and trace how the docs parser handles bullet lists alongside an explicit Returns <type> declaration. Reproduce the incorrect getPreferredSystemLanguages() declaration and verify that the generated return type no longer contains duplicated bullet-list entries.

Written by the indexing model from the issue text.

Description

:beetle: bug

See https://github.com/electron/electron/issues/37781 - this lead to a wildly incorrect return type of:

getPreferredSystemLanguages(): Array<'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()' | 'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()'>;
Dominant language
TypeScript
Stars
29
Forks
19
Avg merge
5h 31m
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from electron/docs-parser

All issues in electron/docs-parser

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.