dotnet / dotnet/api-docs-sync

PortToDocs changing many docs which aren't touched by intellisense input

オープン
#179 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
14
フォーク
21
PR マージ指標
30日以内にマージされた PR はありません

説明

It seems to be trying to copy the docs from the interface and/or inheritdoc target.

It shouldn't do this, since it duplicates the doc content. If a member has inheritdoc already the docs build will automatically copy the docs. If a member implements an interface then we can add inheritdoc to opt-in to this.

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

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

調査の方向性

まず PortToDocs のエントリーポイントを見つけ、interface または inheritdoc のドキュメントが IntelliSense の入力に含まれていないにもかかわらずコピーされるケースを再現します。変更対象として選択されるメンバーを追跡し、既存の inheritdoc の動作が引き続き docs build に委譲されていることを確認します。関係のないメンバーが変更されなくなり、interface の実装が inheritdoc を明示的に追加した場合にのみ変更されれば完了です。

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

評価

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

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

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