Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Merge pull request #9 from blambeau/cheatsheet

add a summary of available letters in README
  • Loading branch information...
commit 5054db04ac3ce40b8364c7737ac15504d0874b0d 2 parents c0106a5 + b4f7aa9
David Jacobs authored

Showing 1 changed file with 17 additions and 0 deletions. Show diff stats Hide diff stats

  1. +17 0 README.md
17 README.md
Source Rendered
@@ -54,3 +54,20 @@ This is significantly easier than breaking apart the pipeline using variable ass
54 54
55 55 The `o` method takes options, too, so you can add a prefix message to the output or choose another output format -- like [YAML]() or [pretty print]().
56 56
  57 +### Available letters
  58 +
  59 +- `a` (Assert) asserts in the context of its receiver or Letters::AssertionError
  60 +- `b` (Beep) causes your terminal to beep
  61 +- `c` (Callstack) prints the current callstack
  62 +- `d` (Debugger) passes control to the debugger
  63 +- `d1`/`d2` (Diff) prints a diff between first and second receivers
  64 +- `e` (Empty) raises a Letters::EmptyError if its receiver is empty
  65 +- `f` (File) writes its receiver into a file in a given format
  66 +- `j` (Jump) executes its block in the context of its receiver
  67 +- `l` (Logger) logs its receivers on the available logger instance
  68 +- `m` (Taint) taints (or untaints) its receiver
  69 +- `n` (Nil) raises a Letters::NilError if its receiver is nil
  70 +- `o` (stdOut) prints its receiver to standard output
  71 +- `r` (Ri) prints RI documentation of its receiver class
  72 +- `s` (Safety) bumps the safety level (by one or as specified)
  73 +- `t` (Timestamp) prints out the current timestamp

0 comments on commit 5054db0

Please sign in to comment.
Something went wrong with that request. Please try again.