Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document versioned RBI annotations #258

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Conversation

egiurleo
Copy link
Contributor

Type of Change

  • Add RBI for a new gem
  • Modify RBI for an existing gem
  • Other: Documentation

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/documentation folder, 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!

@egiurleo egiurleo requested a review from a team as a code owner June 28, 2024 16:09
@egiurleo egiurleo requested review from amomchilov and KaanOzkan June 28, 2024 16:09
README.md Outdated Show resolved Hide resolved
rbi/documentation/versioned_annotations.md Outdated Show resolved Hide resolved
@egiurleo egiurleo force-pushed the emily/versioned-rbi-documentation branch from f1bb189 to 7b2c449 Compare November 14, 2024 16:50
Copy link
Contributor

@Morriar Morriar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

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 egiurleo force-pushed the emily/versioned-rbi-documentation branch from 7b2c449 to e3ed4ef Compare November 18, 2024 15:09
@egiurleo egiurleo merged commit 12762cc into main Nov 18, 2024
4 checks passed
@egiurleo egiurleo deleted the emily/versioned-rbi-documentation branch November 18, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants