Skip to content

Instantly share code, notes, and snippets.

View obiyuta's full-sized avatar
:octocat:

Obi Yuta obiyuta

:octocat:
View GitHub Profile

YARD CHEATSHEET http://yardoc.org

cribbed from http://pastebin.com/xgzeAmBn

Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD.

Modules

Namespace for classes and modules that handle serving documentation over HTTP

Keybase proof

I hereby claim:

  • I am obiyuta on github.
  • I am obiyuta (https://keybase.io/obiyuta) on keybase.
  • I have a public key ASBjaPFz_oFOVHe8FjCWgBL-6gtpqubvRbsTw3iQiIBUKgo

To claim this, I am signing this object:

require: rubocop-rspec
# app
AllCops:
DisplayCopNames: true
Style/Documentation:
Enabled: false
Style/AsciiComments:
Enabled: false
Style/StringLiterals: