electron / electron/docs-parser

multi-mode Class description error

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

説明

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

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

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

調査の方向性

まず、Issue にリンクされている例を使ってマルチモードのパース動作を再現し、その後、最初のコンストラクターまでクラスの説明がどのように収集されるかを追跡します。各クラスが自分自身の説明だけを保持し、コンストラクターのないクラスも含めて、過度に大きな結合文字列を生成しない状態になれば完了です。

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

評価

技術スタック
typescript
領域
documentation, tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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