dotnet / dotnet/api-docs-sync

Automatically add boilerplate summary for auto-added parameterless constructors

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

説明

[HalfConverter](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/HalfConverter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34), [Int128Converter ](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/Int128Converter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34)or [UInt128Converter](https://github.com/dotnet/dotnet-api-docs/blob/2dd74450dc9f8f6e7fc586fbcf0f04d34333eaab/xml/System.ComponentModel/UInt128Converter.xml?rgh-link-date=2022-08-10T22%3A26%3A39Z#L34), have their documentation xml file created in this location:

runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml

None of these 3 APIs have an xml entry for a parameterless constructor, but it gets added to the dotnet-api-docs file automatically anyway. According to [this programming guide doc](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/instance-constructors#parameterless-constructors), it's valid.

To fix this:

- We need to agree on a generic boilerplate message that would apply to all APIs. Something like:

> `Creates a new instance with default values.`

- We need investigate if it’s possible to determine if a parameterless constructor was autogenerated by the compiler and that’s why I was unable to find its docs in the intellisense xml files, or if the problem was that the user provided the wrong artifacts path which does not contain the xml file with that type’s docs.

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

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

調査の方向性

runtime\artifacts\bin\System.ComponentModel.TypeConverter\Release\net7.0\System.ComponentModel.TypeConverter.xml で生成されたエントリを、HalfConverter、Int128Converter、UInt128Converter に対応する dotnet-api-docs の XML ファイルと比較します。パラメーターなしのコンストラクターがコンパイラーによって生成されたものなのか、artifacts path が原因で欠落しているのかを調査し、その後 sync の動作を確認して、汎用的な要約について合意します。原因が確定し、boilerplate の扱いと文言が定義されれば完了です。

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

評価

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

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

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