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.
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.
require File.expand_path('../boot', __FILE__) | |
require 'rails/all' | |
if defined?(Bundler) | |
# If you precompile assets before deploying to production, use this line | |
Bundler.require(*Rails.groups(:assets => %w(development test))) | |
# If you want your assets lazily compiled in production, use this line | |
# Bundler.require(:default, :assets, Rails.env) | |
end |
--- | |
# ^^^ YAML documents must begin with the document separator "---" | |
# | |
#### Example docblock, I like to put a descriptive comment at the top of my | |
#### playbooks. | |
# | |
# Overview: Playbook to bootstrap a new host for configuration management. | |
# Applies to: production | |
# Description: | |
# Ensures that a host is configured for management with Ansible. |
namespace :deploy do | |
before :updated, :setup_solr_data_dir do | |
on roles(:app) do | |
unless test "[ -d #{shared_path}/solr/data ]" | |
execute :mkdir, "-p #{shared_path}/solr/data" | |
end | |
end | |
end | |
end |
namespace :deploy do | |
before :updated, :setup_solr_data_dir do | |
on roles(:app) do | |
unless test "[ -d #{shared_path}/solr/data ]" | |
execute :mkdir, "-p #{shared_path}/solr/data" | |
end | |
end | |
end | |
end |
=Navigating= | |
visit('/projects') | |
visit(post_comments_path(post)) | |
=Clicking links and buttons= | |
click_link('id-of-link') | |
click_link('Link Text') | |
click_button('Save') | |
click('Link Text') # Click either a link or a button | |
click('Button Value') |
package main | |
/* | |
#cgo CFLAGS: -x objective-c | |
#cgo LDFLAGS: -framework Cocoa | |
#import <Cocoa/Cocoa.h> | |
int | |
StartApp(void) { | |
[NSAutoreleasePool new]; |
module['exports'] = function echoHttp (hook) { | |
hook.debug("Debug messages are sent to the debug console"); | |
hook.debug(hook.params); | |
hook.debug(hook.req.path); | |
hook.debug(hook.req.method); | |
<!doctype html> | |
<title>Gatecoin | Maintenance</title> | |
<head> | |
<meta charset="utf-8"> | |
<link href='https://gatecoin.com/public/css/googleFonts.css' rel='stylesheet' type='text/css'> | |
<link rel="icon" href="https://gatecoin.com/public/img/favicon.ico" type="image/png"/> | |
<!--ramen--> | |
<link rel="dns-prefetch" href="https://cdn.ramen.is"> | |
</head> |
#!/usr/bin/env bash | |
# | |
# Bootstrap script for setting up a new OSX machine | |
# | |
# This should be idempotent so it can be run multiple times. | |
# | |
# Some apps don't have a cask and so still need to be installed by hand. These | |
# include: | |
# | |
# - Twitter (app store) |