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

Property documentation should not list EventListener APIs #1620

Open
donmccurdy opened this issue Mar 5, 2025 · 0 comments
Open

Property documentation should not list EventListener APIs #1620

donmccurdy opened this issue Mar 5, 2025 · 0 comments
Labels
bug Something isn't working documentation
Milestone
v4.1

Comments

@donmccurdy
Copy link
Owner

Currently the documentation for classes like AnimationChannel lists EventListener APIs that are intended to be internal implementation details of the library, including:

  • dispatchEvent
  • addEventListener
  • removeEventListener

Note that .dispose() is also inherited from property-graph, but this API is necessary to have documented and should not be removed.
@donmccurdy donmccurdy added bug Something isn't working documentation labels Mar 5, 2025
@donmccurdy donmccurdy added this to the v4.1 milestone Mar 5, 2025
@donmccurdy donmccurdy changed the title Property subclass documentations should not list EventListener APIs Property documentation should not list EventListener APIs Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation
Projects
None yet
Milestone
v4.1
Development

No branches or pull requests
1 participant
@donmccurdy