Skip to content
Explains Ruby syntax http://explainruby.net
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
explanations
fixtures
spec
templates add Gauges tracking code
views add Gauges tracking code
.gitignore
Gemfile code from URL: fix GitHub integration; support HTTPS
Gemfile.lock code from URL: fix GitHub integration; support HTTPS
README.md
Rakefile mongo -> postgres
app.rb
code.rb code from URL: fix GitHub integration; support HTTPS
config.ru
processor.rb Merge remote branch 'radar/master'
rocco_ext.rb

README.md

Explain Ruby

A web tool to teach Ruby. Paste code or a URL to have the syntax explained.

How it works

While made for beginners, the tool is technologically very non-trivial. It uses ruby_parser to break down Ruby code and then ruby2ruby to reconstruct it back while adding documentation in correct places. Finally, the output is ran through Rocco to generate the pretty two-column layout.

Problems

It is in alpha phase. The output still breaks on any code more complex than bare basic Ruby. All the documentation was done by me in a single day. So if you spot how docs can be better, please contribute to the "explanations/" directory. If you feel adventurous, the "processor.rb" (which) needs a lot of love to enable it to handle more complex Ruby code.

Report bugs as issues on GitHub.

Something went wrong with that request. Please try again.