Implement Class Documentation Preview Webviews #754
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
daimor
previously approved these changes
Oct 25, 2021
gjsjohnmurray
requested changes
Oct 26, 2021
Co-authored-by: John Murray <[email protected]>
|
@gjsjohnmurray I chose "Preview" because that's the wording that the builtin Markdown extension uses. I'm ok with switching to "Doc for .." if you and @daimor prefer that |
|
I agree with John, |
daimor
approved these changes
Oct 26, 2021
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.
This PR adds webviews for previewing documentation for the currently open ObjectScript class. The preview will display the rendered HTML description for the class member that the user's cursor is in, or the class itself if the user's cursor isn't inside a class member. If a user switches to a different class, the preview will "follow" the user's cursor and display the documentation for the more recent class. The preview is dynamic (it will update as the user changes the class being previewed) and does not require an active connection to a server to work. The gif below demonstrates the workflow: