docs: add some javadoc on E in hopes that it'll be visible in IDEs #2714
Conversation
This file contains 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
Chris-Hibbert
added
documentation
|
cc: @dckc |
kriskowal
approved these changes
Feb 7, 2025
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.
Closes: #2706
Description
Add some documentation on E, in hopes that it will appear as hovertext in IDEs. Also added an example and a link to the API Documentation.
Security Considerations
No impact
Scaling Considerations
No consequences.
Documentation Considerations
No change to any interface. The goal is to add jsDoc to E.
Testing Considerations
I don't know how to test this before it's deployed. In WebStorm, I was able to see the comment when hovering on E in
no-shim.js, but not anywhere else.Compatibility Considerations
No effects
Upgrade Considerations
None