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

[doc] Eventcallbacks with generic type parameter - wrong API documentation section #803

Closed
hakenr opened this issue May 6, 2024 · 0 comments · Fixed by #806
Closed

[doc] Eventcallbacks with generic type parameter - wrong API documentation section #803

hakenr opened this issue May 6, 2024 · 0 comments · Fixed by #806
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@hakenr
Copy link
Member

hakenr commented May 6, 2024

EventCallback<ModalHidingEventArgs> HxModal.OnHiding renders in Parameters section instead of Event callbacks.
It seems that all the generic EventCallback<T> are rendered in such way.

This probably originated from EventCallback<TValue> ValueChanged parameters where we wanted them in Parameters section.
We can take one of these approaches:

  1. Render ALL event-callbacks in Event callbacks section (incl. ValueChanged).
  2. Create exception for XyChanged event callbacks and leave them as Parameters (part of @bind-Xy syntax). All the other event-callbacks (with or without generic parameter) will be rendered in Event callbacks section (these should start with OnXy prefix, but it is only a convention, not a rule).

@Harvey1214, my preference is 2, but you decide.

@hakenr hakenr added bug Something isn't working documentation Improvements or additions to documentation labels May 6, 2024
@hakenr hakenr added this to the Priority 2 - Normal milestone May 6, 2024
hakenr added a commit that referenced this issue May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
2 participants