Jens Tschirpig jens1101

Fenced code blocks inside ordered and unordered lists

This is a numbered list.
I'm going to include a fenced code block as part of this bullet:
```
Code
More Code
```

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

You know how, in JavaScript, we can set a value to a variable if one doesn't, like this:

name = name || 'joe';

This is quite common and very helpful. Another option is to do:

name || (name = 'joe');

Title

<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>

URL

<The URL Structure (path only, no root url)>
Method:

	$ rails generate scaffold BusinessEntry content:string --no-stylesheets --no-fixture --no-test-framework --no-helper --pretend
	invoke mongoid
	create app/models/business_entry.rb
	route resources :business_entries
	invoke scaffold_controller
	create app/controllers/business_entries_controller.rb
	invoke haml
	create app/views/business_entries
	create app/views/business_entries/index.html.haml
	create app/views/business_entries/edit.html.haml

	-- show running queries (pre 9.2)
	SELECT procpid, age(clock_timestamp(), query_start), usename, current_query
	FROM pg_stat_activity
	WHERE current_query != '<IDLE>' AND current_query NOT ILIKE '%pg_stat_activity%'
	ORDER BY query_start desc;

	-- show running queries (9.2)
	SELECT pid, age(clock_timestamp(), query_start), usename, query
	FROM pg_stat_activity
	WHERE query != '<IDLE>' AND query NOT ILIKE '%pg_stat_activity%'

	<?php
	/*
	This code sample demonstrates several style for representing an option array with
	the following fields: name, label, type_id, visible, default.

	When designing this we should keep in mind that the option key may be represented
	by either a literal or a (class)constant. As such we mix and match those for
	illustrative purposes.
	*/

	# Install ARCH Linux with encrypted file-system and UEFI
	# The official installation guide (https://wiki.archlinux.org/index.php/Installation_Guide) contains a more verbose description.

	# Download the archiso image from https://www.archlinux.org/
	# Copy to a usb-drive
	dd if=archlinux.img of=/dev/sdX bs=16M && sync # on linux

	# Boot from the usb. If the usb fails to boot, make sure that secure boot is disabled in the BIOS configuration.

	# Set swedish keymap

	/* *******************************************************************************************
	* THE UPDATED VERSION IS AVAILABLE AT
	* https://github.com/LeCoupa/awesome-cheatsheets
	* ******************************************************************************************* */


	// 0. Synopsis.
	// http://nodejs.org/api/synopsis.html

	call_user_func(function($arg1, $arg2) {

	// do stuff

	}, $arg1, $arg2);