Issue in generating html output with '&' in @param
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 42/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
提供された @param docstring を使って報告されたケースを再現し、Node v20.15.0 で npm run documentation を実行してください。生成された HTML を期待される body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification の出力と比較し、関連する issue #1641 をコンテキストとして確認してください。完了とは、型が any になるのではなく保持されることを意味します。
索引モデルが issue の本文から書いたものです。
説明
For below docstring:
@param { Required<Pick<Model1, 'name'>> & Partial<Model1> } body specification
expectation is to see below format in documentation:
body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification
but I can see:
body(any) specification
version of documentation pkg: 14.0.3
running documentation: npm run documentation
node version: v20.15.0
Similar issue which was created earlier: https://github.com/documentationjs/documentation/issues/1641
- 主要言語
- JavaScript
- スター
- 5.8k
- フォーク
- 479
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
documentationjs/documentation のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
documentationjs/documentation#1669 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
documentationjs/documentation#1666 · コメント 2 件 ·
-
Fix outdated depsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
documentationjs/documentation#1646 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
documentationjs/documentation#1644 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
documentationjs/documentation#1643 · コメント 1 件 ·
documentationjs/documentation の issue をすべて見る
似ている issue
-
Bump Firebase JS SDK (12.19.0 → 13.0.0)対応中かも @SelaseKay が今日担当しました。 オープンNeeds Attention type: enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
invertase/react-native-firebase#9364 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
tchiotludo/akhq#3307 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 90/100
DietrichGebert/ponytail#1063 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
zen-browser/desktop#15809 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 90/100