electron / electron/docs-parser

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

オープン
#84 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
:beetle: bug
主要言語
TypeScript
スター
29
フォーク
19
平均マージ
5時間 31分
マージ済み PR(30日)
2

説明

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

```ts
getPreferredSystemLanguages(): Array<'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()' | 'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()'>;
```

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

リンクされた Electron issue から始め、docs parser が明示的な `Returns ` 宣言とともに箇条書きリストをどのように処理するかを追跡します。`getPreferredSystemLanguages()` の誤った宣言を再現し、生成された戻り値の型に箇条書きリストのエントリが重複して含まれなくなったことを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。