Learn More About YARD

body { margin: 0; padding: 0;} #logo, #content { padding: 0 20px; } #noscript { background: #111; color: #fff; padding: 10px 20px; } #top_nav { top: 48px; } It seems you've disabled Javascript. That's okay, but you might run into some problems. We try to make things work without script support as much as possible, but sometimes it needs to be used. We apologize for any inconvenience and hope you understand.

RubyDoc.info YARD Documentation Server

RubyDoc.info is your source for open source Ruby library documentation, generating fresh docs for Gems and popular Git repositories.

This site uses YARD to generate docs on the fly. To make your docs look better, you can check out some of YARD's killer features.

We have DISQUS integration! Click the permalink (like this one) on a method to see user comments on a method page.

Looking for a GitHub post-receive hook? Use https://www.rubydoc.info/checkout.

RubyDoc.info was made possible by Loren Segal and Nick Plante, with help from a community of friendly contributors.

Ruby Standard Library

core (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
abbrev (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
base64 (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
benchmark (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
bigdecimal (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
bundler (2.7.0)
cgi (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
cgi-lib (1.8.7, 1.8.6)
cmath (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
complex (2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.9.2)
continuation (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
coverage (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
csv (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
curses (2.2.2, 2.1.6, 2.1.0, 2.0.0, 1.9.3)
date (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
date2 (1.8.7, 1.8.6)
dbm (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
debug (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
delegate (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
did_you_mean (2.7.0)
digest (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
dl (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
drb (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
e2mmap (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
English (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
enumerator (1.8.6)
Env (1.8.7, 1.8.6)
erb (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
eregex (1.8.7, 1.8.6)
etc (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
fcntl (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
fiber (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
fiddle (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
fileutils (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
fileutils.gemspec (2.7.0)
finalize (1.8.7, 1.8.6)
find (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
forwardable (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ftools (1.8.7, 1.8.6)
gdbm (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
generator (1.8.7, 1.8.6)
getoptlong (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
getopts (1.8.7, 1.8.6)
gserver (2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.9.2)
iconv (2.0.0, 1.9.3, 1.9.2, 1.8.7, 1.8.6)
importenv (1.8.7, 1.8.6)
io (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ipaddr (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ipaddr.gemspec (2.7.0)
irb (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
jcode (1.8.7, 1.8.6)
json (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
logger (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
mailread (1.8.7, 1.8.6)
mathn (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
matrix (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
minitest (2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.9.2)
mkmf (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
monitor (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
mutex_m (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
mutex_m.gemspec (2.7.0)
net (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
nkf (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
objspace (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
observer (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
open-uri (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
open3 (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
openssl (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
optionparser (2.7.0, 2.3.1, 2.2.2)
optparse (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ostruct (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
parsearg (1.8.7, 1.8.6)
parsedate (1.8.7, 1.8.6)
pathname (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ping (1.8.7, 1.8.6)
pp (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
prettyprint (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
prime (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
prime.gemspec (2.7.0)
probe (2.0.0, 1.9.3, 1.9.2)
profile (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
profiler (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
pstore (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
psych (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
pty (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
racc (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rake (2.2.2, 2.1.6, 2.1.0, 2.0.0, 1.9.3)
rational (2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.9.2)
rbconfig (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rdoc (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
readbytes (1.8.7, 1.8.6)
readline (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
readline.gemspec (2.7.0)
README (1.9.3, 1.9.2, 1.8.7, 1.8.6)
refinement (2.0.0)
reline (2.7.0)
resolv (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
resolv-replace (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rexml (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rinda (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
ripper (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rss (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rubygems (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
rubyunit (1.8.7, 1.8.6)
rubyvm (2.7.0)
runit (1.8.7, 1.8.6)
scanf (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
sdbm (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
securerandom (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
set (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
shell (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
shellwords (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
singleton (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
soap (1.8.7, 1.8.6)
socket (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
stringio (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
strscan (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
syck (2.2.2, 2.1.6, 2.1.0, 2.0.0, 1.9.3)
sync (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
syslog (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
tempfile (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
test (2.1.6, 2.1.0, 2.0.0, 1.9.3, 1.9.2)
thread (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
thwait (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
time (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
timeout (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
tk (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
tmpdir (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
tracer (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
tsort (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
un (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
unicode_normalize (2.7.0, 2.3.1, 2.2.2)
uri (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
weakref (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
webrick (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
win32 (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
Win32API (1.8.7, 1.8.6)
win32ole (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
wsdl (1.8.7, 1.8.6)
xmlrpc (2.3.1, 2.2.2, 2.1.6, 2.1.0, 2.0.0)
xsd (1.8.7, 1.8.6)
yaml (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)
zlib (2.7.0, 2.3.1, 2.2.2, 2.1.6, 2.1.0)