docs: add comments describing events PE-5900 #103
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Groups events and adds descriptive comments for them. JSDoc style comments are used so that they show up as LSP hover text. @constant annotations were omitted since they seem redundant, but we can add them though if there's utity in doing so.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #103 +/- ##
===========================================
+ Coverage 59.82% 60.08% +0.26%
===========================================
Files 21 21
Lines 5633 5670 +37
Branches 240 240
===========================================
+ Hits 3370 3407 +37
Misses 2261 2261
Partials 2 2 ☔ View full report in Codecov by Sentry. |
karlprieb
approved these changes
Apr 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Groups events and adds descriptive comments for them. JSDoc style comments are used so that they show up as LSP hover text. constant annotations were omitted since they seem redundant, but we can add them if there's utility in doing so.