Arto Bendiken artob

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

Markdown and reStructuredText

GitHub supports several lightweight markup languages for documentation; the most popular ones (generally, not just at GitHub) are Markdown and reStructuredText. Markdown is sometimes considered easier to use, and is often preferred when the purpose is simply to generate HTML. On the other hand, reStructuredText is more extensible and powerful, with native support (not just embedded HTML) for tables, as well as things like automatic generation of tables of contents.

A Common .ruby-version File For Ruby Projects

Background

I've been using this technique in most of my Ruby projects lately where Ruby versions are required:

Create .rbenv-version containing the target Ruby using a definition name defined in ruby-build (example below). These strings are a proper subset of RVM Ruby string names so far...
Create .rvmrc (with rvm --create --rvmrc "1.9.3@myapp") and edit the environment_id= line to fetch the Ruby version from .rbenv-version (example below).

Today I learned about another Ruby manager, rbfu, where the author is using a similar technique with .rbfu-version.

Creating a clean gh-pages branch

This is the sequence of steps to follow to create a root gh-pages branch. It is based on a question at [SO]

cd /path/to/repo-name
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
echo "My GitHub Page" &gt; index.html

This has now been moved to a proper GitHub repository: https://github.com/njh/gen-webid-cert

Please submit issues and enhancements there.

	source "http://rubygems.org"

	gemspec

	group :development do
	gem 'shotgun'
	gem "wirble"
	end

	EThe Times 03/Jan/2009 Chancellor on brink of second bailout for banks
	z+o>z+o>z+o>z+o>z+o>
	z+o>z+o>z+o>z+o>z+o>
	z+o>z+o>z+o>z+o>z+o>
	z+o>z+o>z+o>z+o>z+o>
	z+o>z+o>z+o>z+o>z+o>
	z+o>z+o>z+o>z+o>z+o>
	=ybegin line=128 siz
	e=8776 name=bitcoin.
	**2.+D/+*h+E

	#=== Real life examples ===

	graph = RDF::Graph.new
	# read from file
	graph = RDF::Graph.load("http://datagraph.org/jhacker/foaf.nt")
	# -or- from the web
	graph = RDF::Graph.load("http://dbpedia.org/resource/Elvis_Presley")
	graph << RDF::RDFa::Reader.open("http://www.bestbuy.com/shop/ipad+xoom+-windows")

	graph.each_predicate { \|s\| puts s.inspect }

	# Point end-of-life Ubuntu versions' apt source URLs to old-releases.*
	# See: https://help.ubuntu.com/community/EOLUpgrades
	sudo sed -i s/us.archive.ubuntu/old-releases.ubuntu/g /etc/apt/sources.list
	sudo sed -i s/security.ubuntu/old-releases.ubuntu/g /etc/apt/sources.list
	sudo apt-get update

	<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
	<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>
	<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>
	<%@ taglib prefix="sec" uri="http://www.springframework.org/security/tags" %>