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

Refactor JSDoc blocks for events #4373

Merged
merged 1 commit into from
Jun 26, 2022
Merged

Refactor JSDoc blocks for events #4373

merged 1 commit into from
Jun 26, 2022

Conversation

willeastcott
Copy link
Contributor

  • Drop the @name tag from all events in favor of the @event tag.
  • Drop the @description tag from all events. Now, only 45 instances of the superfluous @description tag remain in the codebase.
  • Move all events to a consistent location in a module. After the constructor seemed common so I standardized on that for now.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

@willeastcott willeastcott added the docs Documentation related label Jun 25, 2022
@willeastcott willeastcott self-assigned this Jun 25, 2022
@willeastcott willeastcott merged commit f50343a into main Jun 26, 2022
@willeastcott willeastcott deleted the jsdoc-event branch June 26, 2022 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants