Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Explains Ruby syntax

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 explanations
Octocat-spinner-32 fixtures
Octocat-spinner-32 spec
Octocat-spinner-32 templates
Octocat-spinner-32 views
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 app.rb
Octocat-spinner-32 code.rb
Octocat-spinner-32 config.ru
Octocat-spinner-32 processor.rb
Octocat-spinner-32 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.