rubyreferences / rubyref

Ruby Programming Language Reference

title	next	permalink
Introduction	/intro/installation.html	/

The Ruby Reference

This book is a reference for the Ruby programming language. It describes the language structure, its core classes and standard library, and provides some additional useful information and links for Ruby development.

The Reference is intended to be always up-to-date with the current Ruby version.

Most of the reference content is taken directly from Ruby documentation and reorganized for easier reading. The core docs were augmented with some quotes from the Ruby website, and some missing content that is written specifically for the book. The source of the book (rendering scripts, config, and unique content) can be found at GitHub.

Happy Hacking!

rubyref's Issues

Versioning

Hello @zverok ,
thank you for this initiative!
Two questions:

• how can we handle Ruby versions in this reference and
• where to put the Changelog between versions?

IRB `__` is undefined

https://rubyreferences.github.io/rubyref/intro/irb.html

How to make __ work in IRB?

irb(main):002:0> __
Traceback (most recent call last):
        2: from /Users/yar/.asdf/installs/ruby/2.5.1/bin/irb:11:in `<main>'
        1: from (irb):2
NameError (undefined local variable or method `__' for main:Object)
Did you mean?  _

on ruby 2.5.1p57

Or if that page was taken automatically from some source, then would be cool to have a link to that source on every such page, maybe there would be the answer.

Suggestion: create a `rubyreferences.github.io` repository

I think you should create a rubyreferences.github.io repository so that the main https://rubyreferences.github.io link will work (not be a 404, as it is now).

It would be helpful to have a simple index.html file in that repository that links out to https://rubyreferences.github.io/rubyref/ and https://rubyreferences.github.io/rubychanges/.

Suggestion: Add a search bar/page?

I'm not sure how feasible this would be, given the nature of how the pages are generated, but it would help with usability if I didn't have to manually check every page to see what a %W() is, for example.

rubyref org now available - use rubyref/rubyref for a shorter (more beautiful) name

Hello, first thanks for the great reference. Keep it up.

To reference issue #10 - FYI: I have now moved all repos from the /rubyref org to /planetruby/quickrefs and closed down the /rubyref org. You are now free and have the option to use (claim) rubyref for a more beautiful name e.g. rubyref/rubyref. Just rename your org to the shorter name. It's all your's (if you want) no strings attached. Cheers. Prost.

Prev/next chapter arrow links missing the "rubyref/" chunck

Hey, thanks for putting up this reference guide.

While browsing I noticed that the prev/next chapter arrow links are pointing to pages without the rubyref/ prefix, causing GH Pages error.

Join the rubyref org?

Hello,
This ruby reference is fantastic. Please keep it up.

If you're interested you're more than welcome to join the /rubyref org and move this repo to rubyref/rubyref, for example.

Cheers. Prost.

"Net::HTTP reference" link is 404

Thanks for creating a nice doc!

I found that "Net::HTTP reference" link here is 404:
https://rubyreferences.github.io/rubyref/stdlib/networking-web/net/http.html

It links to this URL:
https://ruby-doc.org/stdlib-2.5.0/libdoc/net/http/rdoc/Net::HTTP.html
But looks it should be:
https://ruby-doc.org/stdlib-2.5.0/libdoc/net/http/rdoc/Net/HTTP.html