Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Misleading XML summary for ButtonBase.IsPressed #2310

Open
RevZero opened this issue May 3, 2024 · 1 comment
Open

Misleading XML summary for ButtonBase.IsPressed #2310

RevZero opened this issue May 3, 2024 · 1 comment
Labels
documentation Documentation bug or enhancement, does not impact product or test code Priority:3 Work that is nice to have

Comments

@RevZero
Copy link

RevZero commented May 3, 2024

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.

iot/src/devices/Button/ButtonBase.cs

Line 66 in 8460898

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

@krwq
Copy link
Member

krwq commented May 9, 2024

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

@krwq krwq added documentation Documentation bug or enhancement, does not impact product or test code Priority:3 Work that is nice to have and removed untriaged labels May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation bug or enhancement, does not impact product or test code Priority:3 Work that is nice to have
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@krwq @RevZero