[trivial] Add example sources to docstrings in cursorEvents.ts #241250
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
alexander-zw
changed the title
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.
I know the guidelines say to link a Github issue, but this is such a minor change I think it's not necessary.
Adding these examples will help a lot for devs to use the code more easily, without having to test it to see what is returned.
I didn't definitively say these are the only options to keep the possibility of adding more sources in the future to guard against the docs becoming outdated.
These docstrings will be shown on hover in an IDE and on the docs website, e.g. https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.ICursorPositionChangedEvent.html#source.
How to test: Hover over the attribute in an IDE like VSCode with the TypeScript extension to see the changes.