Update README to clarify what --verify does #1817
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
andyw8
reviewed
Mar 12, 2024
bdewater
reviewed
Mar 13, 2024
simonlevasseur
force-pushed
the
readme-verify-option
branch
from
5fbe5cf
to
3834567
Compare
andyw8
approved these changes
Mar 15, 2024
There was a problem hiding this comment.
Looks good to me but let’s have the experts @KaanOzkan or @Morriar confirm.
simonlevasseur
force-pushed
the
readme-verify-option
branch
from
3834567
to
8f6162f
Compare
KaanOzkan
approved these changes
Mar 15, 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.
Motivation
I recently removed the
turbo-railsgem from a repo and ranbin/tapioca gem. It removed the RBI files for that gem andbin/tapioca gems --verifysucceeds. However,bin/typecheckfails because RBIs for other gems have references to Turbo in them and it can't resolve the constant. The fix is to runbin/tapioca gems --allwhich rewrites all of the gem RBIs but in doing so, it also generates a bunch of misc. changes (mostly in comments but also in cases where RBIs might have been impacted by other gems).Implementation
Update the README to clarify what
bin/tapioca gems --verifyis actually doing and why it might yield lots of misc. changes.