Update README note #584
Merged
Update README note #584
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
gmcgibbon
force-pushed
the
update_readme
branch
from
bc859b5 to
5972af7
Compare
andyw8
reviewed
Feb 14, 2024
README.md
Outdated
|
|
||
| Notice that [Ruby Sorbet](https://marketplace.visualstudio.com/items?itemName=sorbet.sorbet-vscode-extension) will only be activated if your project is onboarded to the [Sorbet type checker](https://sorbet.org/). Otherwise, the extension is never activated. | ||
| Note that the Sorbet extension will only be activated if your project is onboarded to the [Sorbet type checker](https://sorbet.org/). Also, the Ruby Debugger extension is being gradually phased out by the Ruby LSP's debugger. For now, you may need to use rdbg for certain debugging use-cases. |
There was a problem hiding this comment.
This could come across as if we're trying to deprecate the rdbg extension, which may upset the maintainers. Perhaps we could say something like:
For debugging, common use cases are handled by this extension, but the seperate
rdbgextension may still be needed for some situations.
There was a problem hiding this comment.
Agreed. I would frame this more as "the Ruby LSP doesn't support all features supported by RDBG, which is why RDBG is included".
There was a problem hiding this comment.
Right, I wasn't sure about the full context. I'll update. Thanks!
Make it clearer that the extension pack includes Sorbet that's conditionally activated. Also that the debugger extension is for advanced use-cases. This should help reduce confusion for some folks unsure if this extension is right for them.
gmcgibbon
force-pushed
the
update_readme
branch
from
5972af7 to
5297f52
Compare
vinistock
approved these changes
Feb 14, 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.
Related to #579
Make it clearer that the extension pack includes Sorbet that's conditionally activated. Also that the debugger extension is on its way out. This should help reduce confusion for some folks unsure if this extension is right for them.