Chris Coetzee chriscz

YARD CHEATSHEET http://yardoc.org

May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e

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

I'm a fan of MiniTest::Spec. It strikes a nice balance between the simplicity of TestUnit and the readable syntax of RSpec. When I first switched from RSpec to MiniTest::Spec, one thing I was worried I would miss was the ability to add matchers. (A note in terminology: "matchers" in MiniTest::Spec refer to something completely different than "matchers" in RSpec. I won't get into it, but from now on, let's use the proper term: "expectations").

Understanding MiniTest::Expectations

Let's take a look in the code (I'm specifically referring to the gem, not the standard library that's built into Ruby 1.9):

# minitest/spec.rb

module MiniTest::Expectations

Each of these commands will run an ad hoc http static server in your current (or specified) directory, available at http://localhost:8000. Use this power wisely.

Discussion on reddit.

Python 2.x

$ python -m SimpleHTTPServer 8000

Git Submodules basic explanation

Why submodules?

In Git you can add a submodule to a repository. This is basically a repository embedded in your main repository. This can be very useful. A couple of usecases of submodules:

Separate big codebases into multiple repositories.

ZeroMQ vs Redis

This document is research for the selection of a communication platform for robot-net.

Goal

The purpose of this component is to enable rapid, reliable, and elegant communication between the various nodes of the network, including controllers, sensors, and actuators (robot drivers). It will act as the core of robot-net to create a standardized infrastructure for robot control.

Requirements:

	=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')

	#!/usr/bin/env bash
	# bash 4.1.5(1) Linux Ubuntu 10.04 Date : 2011-10-04
	#
	# _______________\| noise : ambient Brown noise generator (cf. white noise).
	#
	# Usage: noise [minutes=59] [band-pass freq center=1786] [wave]
	# ^minutes can be any positive integer.
	# Command "noise 1" will display peak-level meter.
	#
	# Dependencies: play (from sox package)

	#!/bin/sh

	ProgName=$(basename $0)

	sub_help(){
	echo "Usage: $ProgName <subcommand> [options]\n"
	echo "Subcommands:"
	echo " bar Do bar"
	echo " baz Run baz"
	echo ""

	Here's how to make jQuery DataTables work with npm and webpack. DT checks for AMD compatibility first
	which breaks when you're using CommonJS with webpack.

	Install DT core: npm install datatables.net
	Install a DT style: npm install datatables.net-bs (bootstrap)
	Install the imports-loader webpack plugin: https://github.com/webpack/imports-loader#disable-amd
	Create a loader "exception" just for DT in webpack.config.js:

	module: {
	loaders: [