search

dotnet / iot

This repo includes .NET Core implementations for various IoT boards, chips, displays and PCBs.
MIT License
2.12k stars 574 forks source link

Misleading XML summary for ButtonBase.IsPressed #2310

Open RevZero opened 1 month ago

RevZero commented 1 month ago

Current XML summary is

Define if single press event is enabled or disabled on the button.

However, the IsPressed property indicates, if the button is currently pressed.

Proposed summary

Indicates if the button is currently pressed.

Furthermore, the property should probably have a private or protected setter.

https://github.com/dotnet/iot/blob/8460898df2061230a5d45832a56a14d731d117e5/src/devices/Button/ButtonBase.cs#L66

krwq commented 1 month ago

[Triage] Hey @RevZero, are you perhaps interested in making a PR? For comments changes you don't really need to build entire repo