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.

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

Remove excessive Grid API comment #24037

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Conversation

jfversluis
Copy link
Member

Description of Change

The current example for the Grid API docs is a bit much and can be annoying to work with when inside of Visual Studio. See the screenshot underneath taken from: https://developercommunity.visualstudio.com/t/excessive-examples-in-comment-popup/10638087

This PR removes the example reducing the API doc to an acceptable level.

image

@jfversluis jfversluis added area-docs Conceptual docs, API docs, Samples t/housekeeping ♻︎ labels Aug 6, 2024
@jfversluis jfversluis requested a review from a team as a code owner August 6, 2024 13:04
@jfversluis jfversluis self-assigned this Aug 6, 2024
@jfversluis jfversluis enabled auto-merge (squash) August 9, 2024 14:57
@jfversluis jfversluis merged commit 68b0ad2 into main Aug 9, 2024
97 checks passed
@jfversluis jfversluis deleted the remove-excessive-grid-comment branch August 9, 2024 14:59
@samhouts samhouts added the fixed-in-net8.0-nightly This may be available in a nightly release! label Aug 12, 2024
@samhouts samhouts added the fixed-in-net9.0-nightly This may be available in a nightly release! label Aug 27, 2024
@axa88
Copy link

axa88 commented Aug 31, 2024

wonderful. No code samples in comments probably should be added to the project coding styles.
For by every measure measure what was done to Grid should be applied to every other type that saw fit to place code samples, let alone excessive code samples in its comment.
See StackLayout

I digress #24114

There maybe others though, even what's in Label is uselessly verbose...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-docs Conceptual docs, API docs, Samples fixed-in-net8.0-nightly This may be available in a nightly release! fixed-in-net9.0-nightly This may be available in a nightly release! t/housekeeping ♻︎
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants