dotnet / dotnet/dotnet-api-docs

Winforms - Control.ResetBindings() summary seems incorrect?

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

説明

Right now the xml summary for `Control.ResetBindings` reads:

```csharp
Causes a control bound to the to reread all the items in the list and refresh their displayed values.
```

[Docs](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.control.resetbindings?view=netframework-4.7.2#System_Windows_Forms_Control_ResetBindings) - [Control.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Forms/Control.xml)

The implementation clears all the bindings though:

```csharp
public void ResetBindings() {
ControlBindingsCollection bindings = (ControlBindingsCollection)Properties.GetObject(PropBindings);
if (bindings != null) {
bindings.Clear();
}
}
```

[Source](https://github.com/dotnet/winforms/blob/432926c306dcb5bd61d6a3299a647c02b5f51ffa/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs#L1222)

I think perhaps this summary was copied from `BindingSource`? ([Docs](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.bindingsource.resetbindings?view=netframework-4.7.2#System_Windows_Forms_BindingSource_ResetBindings_System_Boolean_))

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

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

調査の方向性

xml/System.Windows.Forms/Control.xml から始め、リンク先の Control.cs ソースにある Control.ResetBindings の実装と比較します。実装に照らしてドキュメント化された動作を確認し、その後 XML の概要を更新して、結果として得られる API ドキュメントを検証します。

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

評価

技術スタック
csharp
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

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

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