RubyDoc.info YARD Documentation Server

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 http://rubydoc.info/checkout.

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

• Featured
• Stdlib
• RubyGems
• Github

Github Projects Listing (links without frames)

• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z
• Latest

• raubarede/s2s (master)
• qoobaa/s3 (master)
• Alternate forks:
• fiksu/s3io (master)
• k33l0r/s3itch_client (master)
• WillBooth/SABnzbs--Status (master)
• safe (No master fork)
• Alternate forks:
• mispy/safubot (master)
• customersure/sage_one (master)
• devver/saikuro (master)
• slivu/saint (master)
• dubek/salsa20-ruby (master)
• ferrous26/Salut (master)
• railstutorial/sample_app_2nd_ed (master)
• agworld/sangaku (master)
• agworld/sangaku-eyeball (master)
• rgrove/sanitize (master)
• pboling/sanitize_email (master)
• fuzziness/sapnwrfc (master)
• rails/sass-rails (master)
• sauce-labs/sauce_ruby (master)
• Alternate forks:
• saucelabs/sauce_ruby (master)
• saute (No master fork)
• Alternate forks:
• pauldix/sax-machine (master)
• rubymaniac/saxxy (master)
• ruby-bdb/sbdb (master)
• michaelbarton/scaffolder (master)
• guillermo/scalarium (master)
• tommyschaefer/SchaeferScript (master)
• lomba/schema_associations (master)
• schema_plus (No master fork)
• Alternate forks:
• lomba/schema_validations (master)
• louismullie/schiphol (master)
• noted/scholar (master)
• jasherai/scoped_roles (master)
• wvanbergen/scoped_search (master)
• supapuerco/scoped_traversal (master)
• scottkit (No master fork)
• Alternate forks:
• scoutapp/scout_rails (master)
• scout_scout (No master fork)
• Alternate forks:
• moshee/scrape (master)
• assaf/scrapi (master)
• scrawler (No master fork)
• Alternate forks:
• ProtectedMethod/scribd_fu (master)
• Alternate forks:
• scottmessinger/scribd_fu (master)
• soveran/scrivener (master)
• scrobbler (No master fork)
• Alternate forks:
• xhochy/scrobbler (master)
• xhochy/scrobbler-ng-utils (master)
• maca/scruby (master)
• delano/scruffy (master)
• pbhogan/scrypt (master)
• turboladen/sdp (master)
• zhangsu/seal (master)
• bdurand/seamless_database_pool (master)
• laserlemon/search (master)
• kgalli/search_qd (master)
• fnichol/searchef (master)
• binarylogic/searchlogic (master)
• bluefocus/seatgeek (master)
• wenzowski/secret_data (master)
• mbleigh/seed-fu (master)
• rroblak/seed_dump (master)
• Alternate forks:
• rhalff/seed_dump (master)
• zenprogrammer/seed_dump (master)
• deathsyn/seedling (master)
• seedsv (No master fork)
• Alternate forks:
• Bantik/seer (master)
• seesawco/seesaw-rb (master)
• select (No master fork)
• Alternate forks:
• nigelr/selections (master)
• ph7/selenium-client (master)
• lanej/selenium-webdriver (master)
• locks/self-ml (master)
• sem4r (No master fork)
• Alternate forks:
• jlindsey/semantic (master)
• danielharan/semantic-menu (master)
• rubypond/semantic_form_builder (master)
• Pistos/semi-autotest (master)
• sensu/sensu-plugin (master)
• jeremyevans/sequel (master)
• pk/sequel_sluggable (master)
• sanger/sequencescape-client-api (master)
• yannickwurm/sequenceserver (master)
• thomas-mcdonald/serel (master)
• RISCfuture/serialbox (master)
• ksylvest/serializer (master)
• abacha/series_timer (master)
• jlong/serve (master)
• serviceproxy (No master fork)
• Alternate forks:
• TwP/servolux (master)
• YorickPeterse/ses (master)
• ahoward/session (master)
• ckdake/setler (master)
• binarylogic/settingslogic (master)
• sexp_processor (No master fork)
• Alternate forks:
• samleb/sexy_scopes (master)
• sg-ruby (No master fork)
• Alternate forks:
• pangel/sg-ruby (master)
• hecticjeff/sg_node_mapper (master)
• xman/sgc-ruby-cuda (master)
• johanns/sha3 (master)
• DarkTatka/Shadchan (master)
• shadow_puppet (No master fork)
• Alternate forks:
• mdub/sham_rack (master)
• shapelib (No master fork)
• Alternate forks:
• mperham/shapelib (master)
• shareaprayer/shareaprayer (master)
• YorickPeterse/shebang (master)
• nesquena/sheet_mapper (master)
• bspaulding/Sheets (master)
• citizen428/shenanigans (master)
• shift (No master fork)
• Alternate forks:
• rstudio/shiny (master)
• Alternate forks:
• shipping (No master fork)
• Alternate forks:
• ideaoforder/shipping (master)
• binarylogic/shippinglogic (master)
• anthonator/shirtsio (master)
• ipwnstuff/shodan-ios (master)
• matthewtodd/shoe (master)
• why/shoes (master)
• Alternate forks:
• shoes/shoes (master)
• shoes/shoes4 (master)
• Shopify/shopify_api (master)
• shoppr (No master fork)
• Alternate forks:
• bagwanpankaj/shortly (master)
• rtomayko/shotgun (master)
• thoughtbot/shoulda (master)
• thoughtbot/shoulda-context (master)
• shoulda-datamapper (No master fork)
• Alternate forks:
• thoughtbot/shoulda-matchers (master)
• plataformatec/show_for (master)
• route/show_method (master)
• show_sha (No master fork)
• Alternate forks:
• mguinada/shuffler_fm (master)
• mperham/sidekiq (master)
• yabawock/sidekiq-scheduler (master)
• Alternate forks:
• adrian-gomez/sidekiq-scheduler (master)
• phstc/sidekiq-statsd (master)
• gevans/sidekiq-throttler (master)
• tobiassvn/sidetiq (master)
• fredemmott/sidewalk (master)
• selialkile/sieve-parser (master)
• dcrec1/signal (master)
• koraktor/silo (master)
• silverpop (No master fork)
• Alternate forks:
• optimis/simple-auth (master)
• laktek/simple-menu (master)
• andi/simple-navigation (master)
• dmke/simple-password-gen (master)
• jongilbraith/simple-private-messages (master)
• cardmagic/simple-rss (master)
• zenkay/simple-spreadsheet (master)
• Djo/simple_analytics (master)
• neopoly/simple_assertions (master)
• gtarnovan/simple_audit (master)
• jasonroelofs/simple_aws (master)
• Alternate forks:
• jameskilton/simple_aws (master)
• simple_column_search (No master fork)
• Alternate forks:
• plataformatec/simple_form (master)
• maz/simple_growl (master)
• fdietz/simple_metrics (master)
• fdietz/simple_metrics-client (master)
• fxposter/simple_model_translations (master)
• simple_money (No master fork)
• Alternate forks:
• simple_navigation (No master fork)
• Alternate forks:
• simple_nested_set (No master fork)
• Alternate forks:
• laserlemon/simple_oauth (master)
• francois/simple_queues (master)
• appoxy/simple_record (master)
• dwradcliffe/simple_site (master)
• erichmenge/simple_user_auth (master)
• colszowka/simplecov (master)
• pbosetti/SimpleIPC (master)
• simplenote (No master fork)
• Alternate forks:
• propublica/simpler-tiles (master)
• mordilion/simpleSlider (master)
• SimpleVOCopen-Ruby (No master fork)
• Alternate forks:
• rbarazi/simply_searchable (master)
• peritor/simply_stored (master)
• simul8-experiments (No master fork)
• Alternate forks:
• sinatra (No master fork)
• Alternate forks:
• sinatra/sinatra (master)
• rstacruz/sinatra-assetpack (master)
• trekdemo/sinatra-basicauth (master)
• darkhelmet/sinatra-bundles (master)
• sinatra-contrib (No master fork)
• Alternate forks:
• sinatra/sinatra-contrib (master)
• SFEley/sinatra-flash (master)
• AF83/sinatra-geckoboard (master)
• shtirlic/sinatra-jsonp (master)
• ruby-rdf/sinatra-linkeddata (master)
• yb66/Sinatra-Partial (master)
• Alternate forks:
• lenary/Sinatra-Partial (master)
• mifo/sinatra-rabbit (master)
• cehoffman/sinatra-respond_to (master)
• blindgaenger/sinatra-rest (master)
• SFEley/sinatra-sessionography (master)
• sinefunc/sinatra-support (master)
• jphastings/sinatra-torrent (master)
• jsmestad/sinatra_warden (master)
• sinsk (No master fork)
• Alternate forks:
• plamoni/SiriProxy (master)
• Ung-UTT/Site-etu-v9 (master)
• wkm/sitefuel (master)
• christianhellsten/sitemap-generator (master)
• kjvarga/sitemap_generator (master)
• lassebunk/sitemap_notifier (master)
• sickboy/six_sync (master)
• SixArm/sixarm_ruby_alpha_bravo (master)
• SixArm/sixarm_ruby_array_slice (master)
• SixArm/sixarm_ruby_defining (master)
• SixArm/sixarm_ruby_http_status_codes (master)
• SixArm/sixarm_ruby_pathname_dirnames (master)
• SixArm/sixarm_ruby_rexml (master)
• SixArm/sixarm_ruby_rexml_element_new_with_options (master)
• SixArm/sixarm_ruby_secure_token (master)
• SixArm/sixarm_ruby_string_to_class (master)
• SixArm/sixarm_ruby_week (master)
• SixArm/sixarm_ruby_xml_load (master)
• SixArm/sixarm_ruby_xml_strip (master)
• skarb/skarb (master)
• jimfoltz/SketchUp-Ruby-API-Doc (master)
• kintamanimatt/skinny-daemon (master)
• anthonator/skittles (master)
• recurly/SKLES (master)
• ronyv89/skydrive (master)
• Antti/skyper (master)
• AlexsJones/skyruby (master)
• geraldb/slideshow (master)
• slim-template/slim (master)
• injekt/slop (master)
• bkoski/slug (master)
• heroku/slug-compiler (master)
• RISCfuture/slugalicious (master)
• stevenosloan/slugity (master)
• danbee/slugtastic (master)
• smart-proxy (No master fork)
• Alternate forks:
• smart_field_constraints (No master fork)
• Alternate forks:
• dadooda/smart_hash (master)
• dadooda/smart_tuple (master)
• costan/smartcard (master)
• mcolyer/smartermeter (master)
• datamuc/smbbrowser (master)
• cajun/smile (master)
• optimis/smilodon (master)
• benschwarz/smoke (master)
• jtran/smoke_signals (master)
• brendanlim/sms-fu (master)
• Hauleth/smsapi (master)
• jbrowning/snafu (master)
• paradox460/snoo (master)
• iwillspeak/snooper (master)
• site5/snuggie (master)
• soap4r-noeticpenguin (No master fork)
• Alternate forks:
• noeticpenguin/soap4r-noeticpenguin (master)
• josukintana/social (master)
• huacnlee/social-share-button (master)
• social_stream (No master fork)
• Alternate forks:
• ging/social_stream (master)
• jsmestad/socialite (master)
• cmer/socialization (master)
• Socket.IO (No master fork)
• Alternate forks:
• socky/socky-authenticator-ruby (master)
• socky/socky-client-rails (master)
• socky/socky-client-ruby (master)
• socky/socky-server-ruby (master)
• socky_plugin (No master fork)
• Alternate forks:
• softlayer/softlayer-api-ruby-client (master)
• softlayer/softlayer-object-storage-ruby (master)
• jgoizueta/solar (master)
• solrizer (No master fork)
• Alternate forks:
• projecthydra/solrizer (master)
• projecthydra/solrizer-fedora (master)
• site5/solusvm (master)
• burisu/somatsu (master)
• jrmehle/songkickr (master)
• sorcerer (No master fork)
• Alternate forks:
• NoamB/sorcery (master)
• agworld/soroban (master)
• shuber/sortable (master)
• thoughtbot/sortable_table (master)
• apeiros/sorting (master)
• seatgeek/soulmate (master)
• soundcloud/soundcloud-ruby (master)
• sourcify (No master fork)
• Alternate forks:
• svenfuchs/space (master)
• ruby-rdf/sparql (master)
• ruby-rdf/sparql-algebra (master)
• Alternate forks:
• gkellogg/sparql-algebra (master)
• sparql-client (No master fork)
• Alternate forks:
• gkellogg/sparql-client (master)
• ruby-rdf/sparql-client (master)
• ruby-rdf/sparql-grammar (master)
• Alternate forks:
• gkellogg/sparql-grammar (master)
• kofno/Sparrowhawk (master)
• wapcaplet/spass (master)
• fragility/spatial_adapter (master)
• ochko/spawn (master)
• Alternate forks:
• tra/spawn (0e1ab9, master)
• sandro/specjour (master)
• spherical (No master fork)
• Alternate forks:
• kpumuk/sphinx (master)
• danryan/spice (master)
• djtek/spiceinit (master)
• me/spider (master)
• postmodern/spidr (master)
• ywen/spinach (2156b7)
• Alternate forks:
• codegram/spinach (master)
• Prydonius/spinning_cursor (master)
• datagraph/spira (master)
• andrew/split (master)
• selialkile/split-where (master)
• sporkrb/spork (master)
• sport.db.admin (No master fork)
• Alternate forks:
• geraldb/sport.db.admin (master)
• Burgestrand/spotify (master)
• britishtea/spotify-metadata (master)
• zdavatz/spreadsheet (master)
• spree/spree (master)
• Alternate forks:
• andrew/spree-api-client (master)
• spree/spree-gift-cards (master)
• garytaylor/spree-paypal-standard (master)
• pronix/spree_amazon_api (master)
• pronix/spree_downloadable (master)
• spree/spree_gateway (master)
• jpablobr/spree_mini_contact (master)
• jpablobr/spree_product_enquiry (master)
• spree/spree_store_credits (master)
• spreedly/spreedly-gem (master)
• crafterm/sprinkle (master)
• steakknife/sprinkles (master)
• Alternate forks:
• craigw/sprinkles (master)
• sstephenson/sprockets (master)
• rails/sprockets-rails (master)
• Alternate forks:
• sstephenson/sprockets-rails (master)
• petebrowne/sprockets-sass (master)
• ryanong/spy (master)
• RISCfuture/sql_origin (master)
• sql_tree (No master fork)
• Alternate forks:
• luislavena/sqlite3-ruby (master)
• sqlite3_ar_regexp (No master fork)
• Alternate forks:
• AaronLasseigne/sqlite3_ar_regexp (master)
• squall (No master fork)
• Alternate forks:
• ernie/squeel (master)
• squeezer (No master fork)
• Alternate forks:
• bvision/squirm (master)
• squirrel (No master fork)
• Alternate forks:
• jacksonwillis/srs_game (master, 12ea00)
• edsu/sru-ruby (master)
• bsm/ssdb-rb (master)
• leehambley/sshkit (master)
• Alternate forks:
• wacku/sshkit (master)
• rails/ssl_requirement (master)
• mdh/ssm (master)
• pboling/stackable_flash (master)
• stalker (No master fork)
• Alternate forks:
• jeremyw/stamp (master)
• stamps (No master fork)
• Alternate forks:
• louismullie/stanford-core-nlp (master)
• sul-dlss/stanford-mods (master)
• starling/starling (master)
• smulube/stashboard-ruby (master)
• winton/stasis (master)
• davidlee/state-fu (master)
• pluginaweek/state_machine (master)
• wvanbergen/state_machine-audit_trail (master)
• ryanza/stateflow (master)
• staticmatic/staticmatic (master)
• acatighera/statistics (master)
• reinh/statsd (master)
• dawanda/statsd-client (master)
• Alternate forks:
• github/statsd-ruby (master)
• tmarkiewicz/statsmix (master)
• status_enumerator (No master fork)
• Alternate forks:
• statusfront/statusfront-ruby (master)
• ooyala/statusz (master)
• cavalle/steak (master)
• koraktor/steam-condenser (master)
• koraktor/steam-condenser-ruby (master)
• bnadlerjr/stemmer (master)
• sterile (No master fork)
• Alternate forks:
• stompgem/stomp (master)
• iande/stomper (master)
• thriventures/storage_room_gem (master)
• viatropos/storefront (master)
• vikhyat/StormyCloud (master)
• storq (No master fork)
• Alternate forks:
• strawberry (No master fork)
• Alternate forks:
• monora/stream (master)
• streamio-rb (No master fork)
• Alternate forks:
• brianmario/streamly (master)
• PoseBiz/stretcher (master)
• chubas/stretto (master, c56092)
• drewtempelmeyer/strikeiron (master)
• string_master (No master fork)
• Alternate forks:
• synbioz/string_to_sha1 (master)
• serradura/string_utility_belt (master)
• rsl/stringex (master)
• mseymour/stringtrain (master)
• serradura/stringub-commons (master)
• rmm5t/strip_attributes (master)
• BM5k/stripe-example (master)
• stripe/stripe-ruby (master)
• jwaldrip/stripe_rails (master)
• rubyworks/strmask (master)
• rails/strong_parameters (master)
• spikex/strongbox (master)
• learnable/strongroom (master)
• hakanensari/structure (master)
• schmidt/structured_warnings (master)
• susestudio/studio_api (master)
• Alternate forks:
• jreidinger/studio_api (master)
• colszowka/stupid_formatter (master)
• kputnam/stupidedi (master)
• pluginaweek/styled_inputs (master)
• netzpirat/stylus_assets (master)
• roundlake/styx (master)
• mbleigh/subdomain-fu (master)
• Alternate forks:
• RISCfuture/subdomain_router (master)
• mholling/subdomain_routes (master)
• subdomainr (No master fork)
• Alternate forks:
• jfernandez/submarine (master)
• jasontruluck/subordinate (master)
• bramswenson/subprocess (master)
• subscription_fu (No master fork)
• Alternate forks:
• sucker (No master fork)
• Alternate forks:
• chicks/sugarcrm (master)
• rubymotion/sugarcube (master)
• dburkes/suid (master)
• thoughtfusion/suitcase (master)
• aergonaut/sulu (master)
• blambeau/summaryse (master)
• weddingcakes/sunsap (master)
• sunspot/sunspot (master)
• Alternate forks:
• outoftime/sunspot (master)
• ogorun/sunspot_activerecord (master)
• bdurand/sunspot_index_queue (master)
• jugyo/sunspot_mongoid (master)
• outoftime/sunspot_rails (master)
• giovannelli/sunspot_stats (master)
• smtlaissezfaire/sup (master)
• superfeedr/superfeedr-ruby (master)
• maccman/supermodel (master)
• octplane/SuperUnpack (master)
• runtimerevolution/survey (master)
• ample/surveygizmo (master)
• asimy/surveyor (master)
• Alternate forks:
• NUBIC/surveyor (master)
• presskey/sushi (master)
• bernerdschaefer/svg (master)
• jraregris/svirfneblin (master)
• codefoundry/svn (master)
• gaqzi/svt-recorder (master)
• Titifonky/SW_Frameworks2013_for_VBA_in_CS (master)
• suvash/swedbanker (master)
• sweet_sweeps (No master fork)
• Alternate forks:
• marcandre/swf_fu (master)
• zeke/swf_train (master)
• shanna/swift (master)
• apeiros/swissmatch (master)
• apeiros/swissmatch-directories (master)
• apeiros/swissmatch-location (master)
• SwissParser (No master fork)
• Alternate forks:
• CottageLabs/sword2ruby (master)
• samuil/sxrb (master)
• sygnal/sygnal-ruby-gem (master)
• kelseymok/syllable-counter (master)
• kelseymok/syllable_counter (master, 4a7585)
• phluid61/symbol_lookup-gem (master)
• mobmewireless/sync_service (master)
• syndibot/syndi (master)
• lpar/syndication (master)
• artemk/syntaxer (master)
• djberg96/sys-filesystem (master)
• Graylog2/syslog-sd-rb (master)
• syslog2logan (No master fork)
• Alternate forks:
• crohr/syslogger (master)
• Watson1978/system_control (master)
• ahoward/systemu (master)