Add heredoc delimiter documentation on hover #2617
Merged
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
vinistock
added
enhancement
andyw8
reviewed
Sep 24, 2024
andyw8
approved these changes
Sep 24, 2024
andyw8
reviewed
Sep 24, 2024
And maybe Thanks for chatting through this with me, @vinistock !! :D Would be great to help developers. That memory of heredoc confusion ~10 years ago still sticks with me! |
Co-authored-by: Nick Schwaderer <Schwad@users.noreply.github.com>
vinistock
force-pushed
the
vs-add-heredoc-hover
branch
from
5f233fa to
2bf4527
Compare
Great idea! I added that for all three heredoc types ( |
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.
Motivation
Was chatting with @Schwad about how heredocs can be quite confusing for new developers. You wouldn't even know the right term to research in order to discover what they are.
We can improve the situation with a simple hover, explaining that it's a heredoc and showing the detected delimiter.
Implementation
Just started handling string nodes in hover. The delimiter extraction is the same as the one in on type formatting.
Automated Tests
Added a test.