dotnet / dotnet/dotnet-api-docs

Inconsistent documentation for DbParameterCollection.CopyTo

オープン
#5,145 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
area-System.Collections Pri3 untriaged
主要言語
C#
スター
949
フォーク
1.7k
平均マージ
2日 19時間
マージ済み PR(30日)
52

説明

I found an anomaly in the docs for DbParameterCollection ( [dotnet-api-docs/xml/System.Data.Common/DbParameterCollection.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Data.Common/DbParameterCollection.xml) ). In the CopyTo method, the documentation claims that the values in the input array are copied to the collection. However, the documentation for the interface (IDataParameterCollection) and the documentation for SqlParameterCollection claim the values in the collection are copied into the input array.

I wasn't sure which way would be the expected behavior, and I didn't have time to read the .NET source code, so I wanted to document this. If nobody know off the top of their head, I'll try to loop back to research it out and fix it later :)

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

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

調査の方向性

dotnet-api-docs/xml/System.Data.Common/DbParameterCollection.xml から始め、CopyTo の記述を IDataParameterCollection および SqlParameterCollection と比較します。.NET ソースを調査してコピーの実際の方向を判断し、その後、一貫していないドキュメントを更新して、影響を受ける API ページを確認します。

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

評価

技術スタック
csharp
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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