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

Add rbs signatures #1161

Draft
wants to merge 15 commits into
base: develop
Choose a base branch
from
Draft

Add rbs signatures #1161

wants to merge 15 commits into from

Conversation

Taeir
Copy link
Contributor

@Taeir Taeir commented Aug 3, 2023

This PR adds so-called RBS type signatures for our codebase.

  • Files in sig/rbs-rails are auto-generated using the rbs-rails tool
  • Files in sig/app are typeprof/RubyMine-generated and manually adapted

NOTE: Please do not review all the RBS files, and definitely ignore all the ones in the rbs-rails directory. If you really want to check stuff, look at the signatures in sig/app.

NOTE 2: I recommend updating to the latest ruby (3.2.2) and if you are using RubyMine, to the latest version (2023.2) as RBS is still in the process of becoming fully mature. The support and feedback from the tools is generally (significantly) better on the latest versions.

@cellio cellio requested a review from ArtOfCode- August 3, 2023 20:24
@Taeir Taeir force-pushed the add-rbs-signatures branch from d7fdb34 to 46c4eb2 Compare August 4, 2023 10:25
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.

1 participant