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.

GitHub Projects Listing

• 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

• kenjij/s-3po (master)
• qoobaa/s3 (master)
• theincognitocoder/s3-xfer (master)
• s3_file (No master fork)
• Alternate forks:
• frezbo/s3_file (master)
• ess/s3_log (master)
• safe-t/safe-t-rest (master)
• Alternate forks:
• bararchy/safe-t-rest (master)
• envato/safe_shell (master)
• elabs/safebox (master)
• ankane/safely (master)
• huacnlee/sails (master)
• LukeHackett/salesforce-live-chat-client (master)
• salesforce/salesforce_flo (master)
• thangtv-1934/sample_app (master)
• Narazaka/sana (master)
• Narazaka/sana-mvcbase (master)
• sanger/sanger_barcode_format (development)
• rgrove/sanitize (master)
• pboling/sanitize_email (master)
• khiav223577/sanitize_sql_like (master)
• ubcsanskrit/sanscript.rb (master)
• johnboyes/santander-cycles (master)
• merimond/saper (master)
• nex3/sass (master)
• Alternate forks:
• sass/sass (master)
• sass/sassc-ruby (master)
• satori-com/satori-rtm-sdk-ruby (master)
• Narazaka/satori_like_dictionary (master)
• sauce-labs/sauce_ruby (master)
• machzqcq/saucelabs (master)
• Cyan101/saucenao (master)
• rubiii/savon (master)
• Alternate forks:
• savonrb/savon (master)
• eve-savvy/savvy-cert (master, a40e2b)
• eve-savvy/savvy-sign-on (master)
• lostisland/sawyer (master)
• rubymaniac/saxxy (master)
• ruby-bdb/sbdb (master)
• robertodecurnex/sc (master)
• fetlife/scallop (master)
• scenic-views/scenic (master)
• Alternate forks:
• thoughtbot/scenic (master)
• ged/schedulability (master)
• botanicus/scheduled-format (master)
• emma-borhanian/schema_expectations (master)
• SchemaPlus/schema_plus (master, v1.8.9)
• SchemaPlus/schema_plus_foreign_keys (master)
• smaximov/schemaful (master)
• harvard-library/schematronium (master)
• scholarsphere (No master fork)
• Alternate forks:
• psu-stewardship/scholarsphere (master)
• tape-tv/schrank (master)
• postmodern/scm (master)
• puppetlabs/scooter (master)
• wvanbergen/scoped_search (master)
• bltavares/ScoreRb (master)
• scorm (No master fork)
• Alternate forks:
• donesafe/scorm (master)
• MikeTaylor/scottkit (master)
• skreem/scram (master, c0e93f)
• sanadan/scrambled_eggs (master)
• abevoelker/scrapinghub (master)
• abevoelker/scrapinghub-client (master)
• gurgeous/scripto (master)
• ifad/scriptoria-core (master)
• pazdera/scriptster (master)
• jmdeldin/scrubba (master)
• tonyhburns/scruin (master)
• pbhogan/scrypt (master)
• scss-lint (No master fork)
• Alternate forks:
• causes/scss-lint (master)
• sul-dlss/sdr-preservation-core (master)
• andrepiske/seaguller (master)
• bdurand/seamless_database_pool (master)
• laserlemon/search (master)
• mrkamel/search_flip (master)
• fnichol/searchef (master)
• ankane/searchkick (master)
• binarylogic/searchlogic (master)
• seccomp-tools (No master fork)
• Alternate forks:
• david942j/seccomp-tools (master)
• getabetterpic/secret_number (master)
• duse-io/secret_sharing_ruby (master)
• neilslater/secret_store (master)
• thiagolmorais/secretaria_virtual (master)
• icbd/secretube.com (master)
• mbleigh/seed-fu (master)
• wycleffsean/seed_drill (master)
• rroblak/seed_dump (master)
• ExpediaDotCom/seiso-import_ldap (master)
• DenisKnauf/select (master)
• arian-amador/select_pdf_api (master)
• self-ml/selfml (master)
• canton7/sem_version (master)
• tomasc/semantic_date_time_tags (master)
• theincognitocoder/semver-string (master)
• pero-ict-solutions/sendcloud (master)
• PavelTyk/sendgrid-rails (master)
• sendgrid/sendgrid-ruby (master)
• EPHEC-Enovatech/sensorygarden-api (master)
• alerta/sensu-alerta (master)
• agent462/sensu-cli (master)
• sensu/sensu-extension (master)
• sensu/sensu-extensions (master)
• sensu/sensu-json (master)
• sensu/sensu-logger (master)
• sensu/sensu-plugin (master)
• sensu/sensu-redis (master)
• rickard-von-essen/sensu-run-check (master)
• sensu/sensu-settings (master)
• sensu/sensu-spawn (master)
• sensu/sensu-transport (master)
• jeremyevans/sequel (master)
• kenaniah/sequel-from_csv (master)
• kenaniah/sequel-through (master)
• arirusso/sequencer (master)
• sequencescape (No master fork)
• Alternate forks:
• sanger/sequencescape (master)
• wurmlab/sequenceserver (master)
• Alternate forks:
• yannickwurm/sequenceserver (master)
• elabs/serial (master)
• inversepath/serialcanbus (master)
• inversepath/SerialCanBus (master)
• hawx/serialisable (master)
• jsonapi-rb/serializable (master)
• jclif/serinette (master)
• jlong/serve (master)
• gillien/servenoble (master)
• ricardovaleriano/servent (master)
• mizzy/serverspec (master)
• Alternate forks:
• serverspec/serverspec (master)
• shhavel/service-oriented-architecture-in-practice-online (master)
• nepalez/service_objects (master)
• TwP/servolux (master)
• grempe/session-keys-rb (master)
• lulalala/settei (master)
• binarylogic/settingslogic (master)
• Alternate forks:
• settingslogic/settingslogic (master)
• bjjb/sfkb (master)
• xman/sgc-ruby-cuda (master)
• johanns/sha3 (master)
• zhenkyle/shadowsocks_ruby (master)
• davydovanton/shallow_attributes (master)
• Alternate forks:
• nesaulov/shallow_attributes (43bb0c, master)
• hermango/shareable (master)
• shareaprayer/shareaprayer (master)
• Plaristote/sharepoint-ruby (master)
• sheetsee.js (No master fork)
• Alternate forks:
• darthnoob/sheetsee.js (master)
• xtrasimplicity/shell-strike (master)
• guard/shellany (master)
• Sirgue/Sherlock (master)
• ruby-rdf/shex (master)
• kigster/shhh (master)
• Chew/ShiftNoteRB (master)
• Madobe/shimapan (master)
• Narazaka/shiolink-ruby (master)
• Narazaka/shioruby (master)
• binarylogic/shippinglogic (master)
• shirasagi/shirasagi (master)
• shodzh/shodzh.github.io (master)
• compose/shoegaze (master)
• shoes/shoes (master)
• shoes/shoes3 (master)
• Alternate forks:
• shoes3/shoes3 (master)
• shoes/shoes4 (master)
• Shopify/shopify_api (master)
• Shopify/shopify_app (master)
• tcd/shopify_util (master)
• tryshoppe/shoppe (master)
• Alternate forks:
• laCour/shoppe (master)
• squeejee/shoppr (master)
• phstc/shoryuken (master)
• thoughtbot/shoulda (master)
• thoughtbot/shoulda-context (master)
• mcorp/shoulda-lotus (master)
• thoughtbot/shoulda-matchers (master)
• plataformatec/show_for (master)
• adeven/shrimp (master)
• projectresound/shrine-ftp (master)
• spejamchr/sia (master)
• mperham/sidekiq (master)
• breamware/sidekiq-batch (master)
• moove-it/sidekiq-scheduler (master)
• utgarda/sidekiq-status (master)
• sidekiq-throttled (No master fork)
• Alternate forks:
• sensortower/sidekiq-throttled (master)
• gevans/sidekiq-throttler (master)
• bdurand/sidekiq-transaction_guard (master)
• mhenrixon/sidekiq-unique-jobs (bf617c)
• ChrisMacNaughton/sidekiq_result (master)
• Latermedia/sidekiq_simple_delay (master)
• Latermedia/sidekiq_spread (master)
• cryo28/sidekiq_status (master)
• bdurand/sidekiq_transaction_guard (master)
• endofunky/sidetiq (master)
• Alternate forks:
• endofunked/sidetiq (master)
• tobiassvn/sidetiq (master)
• barsoom/sie (master)
• SiftScience/sift-ruby (master)
• jacomyal/sigma.js (master)
• signalfx/signalfx-ruby (master, signalflow)
• signalfx-ruby-tracing (No master fork)
• Alternate forks:
• tomichj/signature-pad-rails (master)
• erichmenge/signed_form (master)
• google/signet (master)
• SimonSays (No master fork)
• Alternate forks:
• kigster/simple-feed (master)
• codeplant/simple-navigation (master)
• dmke/simple-password-gen (master)
• euank/simple-pomf-uploader (master)
• cardmagic/simple-rss (master)
• zenkay/simple-spreadsheet (master)
• dvallance/simple_api_client (master)
• neopoly/simple_assertions (master)
• jasonroelofs/simple_aws (master)
• plataformatec/simple_form (master)
• tomasc/simple_form_attachments (master)
• tomasc/simple_form_localized_input (master)
• tomasc/simple_form_markdown_editor (master)
• tomasc/simple_form_recurring_select (master)
• laserlemon/simple_oauth (master)
• simple-oauth2/simple_oauth2 (master)
• Alternate forks:
• 0bman/simple_oauth2 (master)
• simplymadeapps/simple_scheduler (master)
• whatthewhat/simple_segment (master)
• thefury/simple_toggle (master)
• gonzalo-bulnes/simple_token_authentication (master)
• twe4ked/simple_twitter_oauth (master, temp)
• nearapogee/simplec (master)
• colszowka/simplecov (master)
• dashingrocket/simplecov-cobertura (master)
• propublica/simpler-tiles (master)
• sinatra (No master fork)
• Alternate forks:
• sinatra/sinatra (master)
• sinatra/sinatra-contrib (master)
• SFEley/sinatra-flash (master)
• sinatra-formhelpers-ng (No master fork)
• Alternate forks:
• BenFenner/sinatra-formhelpers-ng (master)
• duijf/sinatra-formhelpers-ng (master)
• shtirlic/sinatra-jsonp (master)
• ruby-rdf/sinatra-linkeddata (master)
• mfojtik/sinatra-rabbit (master)
• bcandrea/sinatra-rpc (master)
• jphastings/sinatra-swagger (master)
• archiloque/sinatra-swagger-exposer (master)
• simulacre/sinatra-websocket (master)
• nesquena/sinatra_more (master)
• tomcha/sinatras (master)
• johndistasio/since (master)
• grosser/single_cov (master)
• ndlib/sipity (master)
• cvut/sirius (master)
• jfitisoff/site-object (master)
• buren/site_mapper (master)
• natritmeyer/site_prism (master)
• t-richards/sitemap-ping (master)
• sitemap_generator (No master fork)
• Alternate forks:
• kjvarga/sitemap_generator (master)
• jirkapinkas/sitemonitoring-production (master)
• ab/sixword (master)
• asaaki/sjekksum (master)
• songkick/skab (master)
• bash/skateboard (master)
• mybanktracker/skemata (master)
• mustmodify/sketch (master)
• MSP-Greg/SketchUp (master)
• Aerilius/sketchup-bridge (master)
• jimfoltz/SketchUp-Ruby-API-Doc (master)
• dock0/skipper (master)
• anthonator/skittles (master)
• thomthom/SKUI (master)
• skyarch-networks/sky_zabbix (master)
• Antti/skyper (master)
• otherinbox/skywriter (master)
• gssbzn/slack-api-wrapper (master)
• slack-bot-server (No master fork)
• Alternate forks:
• exciting-io/slack-bot-server (master)
• stevenosloan/slack-notifier (master)
• slack-ruby/slack-ruby-bot (master)
• slack-ruby/slack-ruby-client (master)
• Alternate forks:
• dblock/slack-ruby-client (master)
• slack-smart-bot (No master fork)
• Alternate forks:
• nacyot/slack_scratcher (master)
• apsislabs/slayer (master)
• Arafatk/slearn (master)
• mreq/slick-lightbox (master)
• slide-selector (No master fork)
• Alternate forks:
• Cleveroad/SlidingTutorial-Android (master)
• stonean/slim (master)
• Alternate forks:
• slim-template/slim (master)
• sds/slim-lint (master)
• alphagov/slimmer (documentation)
• slim-template/sliq (master)
• hmans/slodown (master)
• leejarvis/slop (master, v3)
• RISCfuture/slugalicious (master)
• stevenosloan/slugity (master)
• danbee/slugtastic (master)
• sm_sms_campaign_webhook (No master fork)
• Alternate forks:
• ianballou/smart_proxy_m2 (master)
• tilo/smarter_csv (master)
• mcolyer/smartermeter (master)
• rapid7/smb2 (master)
• filterfish/smith2 (master)
• sinch/sms-ruby (master)
• dmagliola/sms_safe (master)
• SPBTV/smsc_ru (master)
• godobject/smuxi (master)
• godobject/smuxi-hooks-ruby (master)
• panorama-ed/snake_case_params (master)
• panorama-ed/snake_params (master)
• jondot/sneakers (master)
• tabolario/snippety (master)
• robertgauld/snmp_pass (master)
• robertgauld/snmp_table_viewer (master)
• paradox460/snoo (master)
• rubyjedi/soap4r (master)
• noeticpenguin/soap4r-noeticpenguin (master)
• CAU-Kiel-Tech-Inf/socha-client-ruby (master)
• CAU-Kiel-Tech-Inf/socha_ruby_client (master)
• social-share-button (No master fork)
• Alternate forks:
• huacnlee/social-share-button (master)
• social-snippet/social-snippet (master)
• social_stream (No master fork)
• Alternate forks:
• ging/social_stream (master)
• socialite (No master fork)
• Alternate forks:
• jsmestad/socialite (master)
• cmer/socialization (master)
• socializer/socializer (master)
• astro/socksify-ruby (master)
• socrata/soda-ruby (master)
• softlayer/softlayer-api-ruby-client (master)
• jgoizueta/solar (master)
• castwide/solargraph (master)
• solidusio/solidus (master)
• solidusio-contrib/solidus_social (master)
• blackwinter/solr4r (master)
• site5/solusvm (master)
• r7kamura/somemoji (master)
• upodesta/somewhere (master, somewhere)
• upodesta/somewhere_upodesta (master)
• rapid7/sonar-client (master)
• songkick/songkick_queue (master)
• songkick/songkick_snippets (master)
• jrmehle/songkickr (master)
• pusewicz/sonia (master)
• samaaron/sonic-pi (master)
• kota65535/sony_camera_remote_api (master)
• NoamB/sorcery (master)
• agworld/soroban (master)
• apeiros/sorting (master)
• seatgeek/soulmate (master)
• soundcloud/soundcloud-ruby (master)
• brewster1134/sourcerer (master)
• wycleffsean/sowed (master)
• glucero/spacedozer (master)
• fastlane/spaceship (master)
• zuazo/spamassassin-cookbook (master)
• topfunky/sparklines (master)
• rrrene/sparkr (master)
• ruby-rdf/sparql (master)
• gkellogg/sparql-algebra (master)
• ruby-rdf/sparql-client (master)
• kofno/Sparrowhawk (master)
• Bloc/spartacus (master)
• Alternate forks:
• bmneely/spartacus (master)
• ksylvest/specifier (master)
• loveablelobster/specify_cli (master)
• zuazo/specinfra-backend-docker_compose (master)
• zuazo/specinfra-backend-docker_lxc (master)
• zuazo/specinfra-backend-docker_nsenter (master)
• robertodecurnex/spectro (master)
• robertodecurnex/spectro-hive (master)
• english/speculation (master)
• Invizory/sperm (master)
• kenkeiter/spherical (master)
• tenderlove/sphero (master)
• kpumuk/sphinx (master)
• danryan/spice (master)
• postmodern/spidr (master)
• codegram/spinach (master)
• ruby-rdf/spira (master)
• pressednet/splinter (master)
• Alternate forks:
• site5/splinter (master)
• andrew/split (master)
• Burgestrand/spotify (master)
• bih/spotify-ruby (master)
• obrie/spotify_web (master)
• projectblacklight/spotlight (master)
• maxcal/spotty (master)
• zdavatz/spreadsheet (master)
• gkosae/spreadshot (master)
• spree/spree (master)
• pronix/spree_amazon_api (master)
• ysynesis/spree_walletone (master)
• spreedly/spreedly-gem (master)
• springboardretail/springboard-client-ruby (master)
• paulholden2/springcm-sdk (0.2.0, 0.3.3, 0.3.1, 0.3.0)
• sprinkle-tool/sprinkle (master)
• rails/sprockets (master)
• Alternate forks:
• sstephenson/sprockets (2.x, master)
• petebrowne/sprockets-helpers (master)
• rails/sprockets-rails (master)
• petebrowne/sprockets-sass (master)
• sprockets-webp (No master fork)
• Alternate forks:
• omghax/sql (master)
• wvanbergen/sql_tree (master)
• sparklemotion/sqlite3-ruby (master)
• Alternate forks:
• luislavena/sqlite3-ruby (master)
• giantmachines/square-ruby (master)
• ernie/squeel (master)
• andymeneely/squib (master)
• Fullscreen/squid (master)
• norman/squirm (master)
• stevecheckoway/squoosh (master, v0.2.0)
• Jofre/srt_processor (master)
• zeiv/SSD1306-ruby (master)
• bsm/ssdb-rb (master)
• zuazo/ssh_authorized_keys-cookbook (master)
• GomaaK/sshez (master)
• capistrano/sshkit (master)
• zuazo/ssl_certificate-cookbook (master)
• bcoles/ssrf_proxy (master)
• pboling/stackable_flash (master)
• tmm1/stackprof (master)
• soveran/stal (master)
• kenn/standby (master)
• louismullie/stanford-core-nlp (master)
• sul-dlss/stanford-mods (master)
• lookout/stapfen (master)
• Fullscreen/star (master)
• timrogers/starling-ruby (master)
• timrogers/starling-terminal (master)
• moski/starwars (master)
• CDLUC3/stash-harvester (master)
• colinxfleming/state_geo_tools (master)
• pluginaweek/state_machine (master)
• CJStadler/state_machine_checker (master)
• state-machines/state_machines (master)
• state-machines/state_machines-activerecord (master)
• state-machines/state_machines-audit_trail (master)
• state-machines/state_machines-mongoid (master)
• state-machines/state_machines-yard (master)
• marcinwyszynski/statefully (master)
• padde/stateoscope (master, v0.1.1)
• soundasleep/statgit2 (master)
• pablocrivella/statics (master)
• vaibhav-y/statistical (master)
• statsample (No master fork)
• Alternate forks:
• SciRuby/statsample (master)
• sciruby/statsample (master)
• reinh/statsd (master)
• github/statsd-ruby (master)
• Alternate forks:
• jeremy/statsd-ruby (master)
• stattleship/stattleship-ruby (master)
• nulldef/statum (master)
• fedux-org/stdlib (master)
• cavalle/steak (master)
• YusefOuda/steam-api (master)
• pboksz/steam-card-tracker (master)
• koraktor/steam-condenser-ruby (master)
• Alternate forks:
• mr64bit/steam-condenser-ruby (master)
• SunDi3yansyah/stisla-jekyll (master)
• SunDi3yansyah/stisla-rails (master)
• stitchfix/stitches (master)
• parabuzzle/stock-markit (master)
• stomp (No master fork)
• Alternate forks:
• stompgem/stomp (master)
• orgsync/stoplight (master)
• mrrooijen/store_schema (master)
• Alternate forks:
• meskyanichi/store_schema (master)
• acidvertigo/storespee (master)
• mattmoore/straight_outta (master)
• ChaelCodes/strawberry-machine-cake (master)
• streakable (No master fork)
• Alternate forks:
• szTheory/streakable (master)
• stream (No master fork)
• Alternate forks:
• monora/stream (master)
• stream-chat-ruby (No master fork)
• Alternate forks:
• stream-rails (No master fork)
• Alternate forks:
• GetStream/stream-ruby (master)
• streamio/streamio-ffmpeg (master)
• derrek/street-address (master)
• stretcher/stretcher (master)
• MarioRuiz/string_pattern (master)
• mseymour/stringtrain (master)
• stripe-ruby (No master fork)
• Alternate forks:
• kachick/striuct (master)
• nurse/strptime (master)
• lyptt/struct (master)
• kachick/struct-alias_member (master)
• kachick/struct-default_value (master)
• kachick/struct-for_pairs (master)
• kachick/struct-validatable (master)
• kachick/structable (master)
• hakanensari/structure (master)
• schmidt/structured_warnings (master)
• justinhoward/strudel (master)
• moustafin/studyruby (master)
• stupidedi (No master fork)
• Alternate forks:
• kputnam/stupidedi (master)
• sibevin/sub_cipher (master)
• shuber/sub_diff (master)
• kenjij/subaru (master)
• kevincjackson/subby (master)
• intridea/subdomain-fu (master)
• Alternate forks:
• mbleigh/subdomain-fu (master)
• jasontruluck/subordinate (master)
• stripe/subprocess (master)
• snusnu/substation (master)
• cloudaffair/subtitle (master)
• brandonhilkert/sucker_punch (master)
• Drakirus/Sudoku (master)
• batebates/sudoku (master)
• samvera/sufia (master)
• sugarcrm/sugar_utils (master)
• chicks/sugarcrm (master)
• rubymotion/sugarcube (master)
• dburkes/suid (master)
• sunspot/sunspot (master)
• chef/supermarket (master)
• redjazz96/supernova (master)
• qw3/superpay_api (master)
• whotwagner/suricata (master)
• surrealist (No master fork)
• Alternate forks:
• nesaulov/surrealist (master)
• skateman/surro-gate (master)
• runtimerevolution/survey (master)
• ample/surveygizmo (master)
• kenchan/suzuri_client (master)
• akerl/svgplot (master)
• yoshoku/SVMKit (master)
• svn-ruby (No master fork)
• Alternate forks:
• tachyons/svn-ruby (master)
• SystemCommandHelperRB/svn_command_helper (master)
• Titifonky/SW_Frameworks2013_for_VBA_in_CS (master)
• fotinakis/swagger-blocks (master)
• swagger-rb/swagger-rb (master)
• lexun/swg-launchpad (master)
• swiftype/swiftype-enterprise-ruby (master)
• swiftype/swiftype-rb (master)
• apeiros/swissmatch-directories (master)
• apeiros/swissmatch-location (master)
• CottageLabs/sword2ruby (master)
• dryruby/sxp (master)
• bendiken/sxp-ruby (master)
• 0exp/symbiont-ruby (master)
• symbols-worldwide/symgate-gem (master)
• airbnb/synapse (master)
• synapsepay/SynapsePayRest-Ruby (master)
• Syncano/syncano-ruby (master)
• BookingSync/synced (master)
• yegor256/syncem (master)
• vyorkin/synchronisable (master)
• layer8x/syncr (master)
• xinminlabs/synvert-core (master)
• r7kamura/syoboi_calendar (master)
• djberg96/sys-proctable (master)
• jgoizueta/sys_cmd (master)
• crohr/syslogger (master)
• ledbettj/systemd-journal (master)

RubyDoc.info is powered by yard 0.9.20 (ruby-2.6.3)

© 2019 DOCMETA, LLC

Sponsored by