rbs icon indicating copy to clipboard operation
rbs copied to clipboard

Link to "The State of Ruby 3 Typing" in the README

Open chrismytton opened this issue 4 years ago • 3 comments

I arrived at this repository via the Ruby 3.0.0 Preview 1 Released blog post.

The README didn't immediately make it clear to me how this might be integrated into a Ruby developer's workflow. After a bit of Googling I came across this excellent blog post, The State of Ruby 3 Typing , which explains the high level purpose of this gem and how it intends to fit into the ecosystem.

I wonder if you'd consider linking to that blog post in the README to make it easier for future visitors to understand the high level goals of the project?

Or perhaps incorporate some parts of the blog post into an expanded version of the README to give more context to the problem this (excellent!) gem is solving.

Thank you for all your hard work on this project ✨

chrismytton avatar Sep 29 '20 19:09 chrismytton

I would like to second this option as the original author commented.

scope2229 avatar Oct 05 '20 14:10 scope2229

My interest in Ruby type checking is new and I've reviewed the helpful blog post cited in this thread as well as the RBS README and Sorbet Type Annotations. To share an opinion - I like the simplicity of the Python type hints and was looking for something similar for Ruby. The closest thing I've found so far is the RubyMine support for YARD documentation tags that provide intellisense hints, RubyMine Document code (with @param, @type @return. I love the power and backward compatibility considerations of the more complete solutions. IMHO there is also a great advantage in having optional type annotations in the source for quick discovery, change (and hopefully, intellisense support). I'm a fan of using static type checking in a fast way when needed and along with dynamic features. I wonder if there is any interest in an inline version of RBS. For new code I'd rather have a single file than have to maintain two.

rlogwood avatar Dec 31 '20 21:12 rlogwood

I wonder if there is any interest in an inline version of RBS. For new code I'd rather have a single file than have to maintain two.

There are 3rd party solutions for now only as far as I'm aware, like sord and yard2steep.

mucaho avatar Sep 04 '22 13:09 mucaho