Document versioned RBI annotations #258
Open
+68
−5
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
KaanOzkan
reviewed
Jul 2, 2024
bdewater
reviewed
Jul 17, 2024
Morriar
reviewed
Jul 18, 2024
paracycle
reviewed
Jul 31, 2024
Add information about `@missing_method` and `@shim` to that section
Versioned RBI annotations allow us to specify which parts of an RBI annotation file are relevant to specific gem versions. This adds documentation for this feature and links to it from the README.
egiurleo
force-pushed
the
emily/versioned-rbi-documentation
branch
from
f1bb189
to
7b2c449
Compare
KaanOzkan
approved these changes
Nov 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.
Type of Change
Changes
I have added documentation for versioned RBI annotations (Shopify/rbi#180), which allow us to specify gem versions for specific methods and constants.
To do this, I have added a
rbi/documentationfolder, where more docs like this could live in the future to help people write RBIs. That might be overkill. Let me know what you think!