Feature Announcement: Type Signatures ✍️

I'm super excited to share with everyone that I've added a new button in Ruby API to show generated type signatures for Ruby 3.0 & 3.1 using the RBS gem. Type Checking in Ruby has been a hot topic for Ruby in the past decade with heavy investment from the ruby-src team with RBS, Stripe's Sorbet & RDL from the University of Maryland. My wish for Ruby's Documentation is to build upon this work and improve the documentation user experience by extracting these type-checking rules into signatures that a human can easily read & understand.

The RBS gem and its integration into Ruby API have greatly interested me, and I first discussed the idea in 2019. Unfortunately, my motivation to work on type signatures became very difficult to find because of COVID-19 and the heavy lockdowns in my city in the past two years. But I'm pleased to have a starting point that I share with people and gather feedback to improve the developer experience further, such as how can we make the type signatures easier to read?

Please Share Your Feedback

I would love to hear any feedback/advice/complaints/suggestions about the Type Signatures. I want to make this something everyone, from developers with years of experience to developers trying ruby for the first time, can use and appreciate. So please leave a comment below or open a new issue! ❤️

Resources

Some resources that helped me to learn more about Type Checking in Ruby:

• 🎥 Type Checking Ruby" by Jeffrey Foster
• 🎥 Soutaro Matsumoto - An Introduction to Static Typing in Ruby 3
• 🎥 RubyConf 2019 - Sorbet: A type checker for Ruby 3... by Jake Zimmerman & Dmitry Petrashko
• 📝 Understanding RBS, Ruby's new Type Annotation System