Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

tweak table on README

  • Loading branch information...
commit e999d7dd80cc096ceed895076f0da1e0dd4f0a0f 1 parent c7d9466
David Jacobs authored
Showing with 249 additions and 288 deletions.
  1. +249 −288 README.md
537 README.md
View
@@ -57,294 +57,255 @@ The `o` method takes options, too, so you can add a prefix message to the output
### Available letters
<table>
-<tr><th>Letter</th><th>Command</th><th>Option(s)</th><th>Description</th></tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#a">a</a>
- </td>
- <td>
- <strong>A</strong>ssert
- </td>
- <td>
- :message
- :error_class
- </td>
- <td>
- asserts in the context of its receiver or Letters::AssertionError
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#b">b</a>
- </td>
- <td>
- <strong>B</strong>eep
- </td>
- <td>
- </td>
- <td>
- causes your terminal to beep
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#c">c</a>
- </td>
- <td>
- <strong>C</strong>allstack
- </td>
- <td>
- :message
- </td>
- <td>
- prints the current callstack
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#d">d</a>
- </td>
- <td>
- <strong>D</strong>ebugger
- </td>
- <td>
-
- </td>
- <td>
- passes control to the debugger
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#d1d2">d1 d2</a>
- </td>
- <td>
- <strong>D</strong>iff
- </td>
- <td>
- :message
- :format
- :stream
- </td>
- <td>
- prints a diff between first and second receivers
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#e">e</a>
- </td>
- <td>
- <strong>E</strong>mpty
- </td>
- <td>
- :message
- </td>
- <td>
- raises a Letters::EmptyError if its receiver is empty
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#f">f</a>
- </td>
- <td>
- <strong>F</strong>ile
- </td>
- <td>
- :format :name
- </td>
- <td>
- writes its receiver into a file in a given format
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#j">j</a>
- </td>
- <td>
- <strong>J</strong>ump
- </td>
- <td>
- (&block)
- </td>
- <td>
- executes its block in the context of its receiver
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#k">k</a>
- </td>
- <td>
- <strong>K</strong>ill
- </td>
- <td>
- :max
- </td>
- <td>
- raises Letters::KillError after a maximum number of calls
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#l">l</a>
- </td>
- <td>
- <strong>L</strong>ogger
- </td>
- <td>
- :format :level
- </td>
- <td>
- logs its receivers on the available logger instance
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#m">m</a>
- </td>
- <td>
- <strong>M</strong>ark as Taint
- </td>
- <td>
- (<strong>true</strong>|false)
- </td>
- <td>
- taints (or untaints) its receiver
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#n">n</a>
- </td>
- <td>
- <strong>N</strong>il
- </td>
- <td>
-
- </td>
- <td>
- raises a Letters::NilError if its receiver is nil
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#o">o</a>
- </td>
- <td>
- std<strong>O</strong>ut
- </td>
- <td>
- :format :stream
- </td>
- <td>
- prints its receiver to standard output
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#r">r</a>
- </td>
- <td>
- <strong>R</strong>i
- </td>
- <td>
- (method name as symbol)
- </td>
- <td>
- prints RI documentation of its receiver class
- </td>
-</tr>
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#s">s</a>
- </td>
- <td>
- <strong>S</strong>afety
- </td>
- <td>
- (level number)
- </td>
- <td>
- bumps the safety level (by one or as specified)
- </td>
-</tr>
-
-
-<tr>
- <td>
- <a href="http://lettersrb.com/api#t">t</a>
- </td>
- <td>
- <strong>T</strong>imestamp
- </td>
- <td>
- :time_format
- </td>
- <td>
- prints out the current timestamp
- </td>
-</tr>
-
+ <tr>
+ <th>Letter</th>
+ <th>Command</th>
+ <th>Option(s)</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#a">a</a>
+ </td>
+ <td>
+ <strong>A</strong>ssert
+ </td>
+ <td>
+ :message,
+ :error_class
+ </td>
+ <td>
+ asserts in the context of its receiver or Letters::AssertionError
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#b">b</a>
+ </td>
+ <td>
+ <strong>B</strong>eep
+ </td>
+ <td>
+ </td>
+ <td>
+ causes your terminal to beep
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#c">c</a>
+ </td>
+ <td>
+ <strong>C</strong>allstack
+ </td>
+ <td>
+ :message
+ </td>
+ <td>
+ prints the current callstack
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#d">d</a>
+ </td>
+ <td>
+ <strong>D</strong>ebugger
+ </td>
+ <td>
+
+ </td>
+ <td>
+ passes control to the debugger
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#d1d2">d1 d2</a>
+ </td>
+ <td>
+ <strong>D</strong>iff
+ </td>
+ <td>
+ :message,
+ :format,
+ :stream
+ </td>
+ <td>
+ prints a diff between first and second receivers
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#e">e</a>
+ </td>
+ <td>
+ <strong>E</strong>mpty
+ </td>
+ <td>
+ :message
+ </td>
+ <td>
+ raises a Letters::EmptyError if its receiver is empty
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#f">f</a>
+ </td>
+ <td>
+ <strong>F</strong>ile
+ </td>
+ <td>
+ :format, :name
+ </td>
+ <td>
+ writes its receiver into a file in a given format
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#j">j</a>
+ </td>
+ <td>
+ <strong>J</strong>ump
+ </td>
+ <td>
+ (&block)
+ </td>
+ <td>
+ executes its block in the context of its receiver
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#k">k</a>
+ </td>
+ <td>
+ <strong>K</strong>ill
+ </td>
+ <td>
+ :max
+ </td>
+ <td>
+ raises Letters::KillError after a maximum number of calls
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#l">l</a>
+ </td>
+ <td>
+ <strong>L</strong>ogger
+ </td>
+ <td>
+ :format, :level
+ </td>
+ <td>
+ logs its receivers on the available logger instance
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#m">m</a>
+ </td>
+ <td>
+ <strong>M</strong>ark as tainted
+ </td>
+ <td>
+ (<strong>true</strong>|false)
+ </td>
+ <td>
+ taints (or untaints) its receiver
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#n">n</a>
+ </td>
+ <td>
+ <strong>N</strong>il
+ </td>
+ <td>
+
+ </td>
+ <td>
+ raises a Letters::NilError if its receiver is nil
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#o">o</a>
+ </td>
+ <td>
+ std<strong>O</strong>ut
+ </td>
+ <td>
+ :format,
+ :stream
+ </td>
+ <td>
+ prints its receiver to standard output
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#r">r</a>
+ </td>
+ <td>
+ <strong>R</strong>i
+ </td>
+ <td>
+ (method name as symbol)
+ </td>
+ <td>
+ prints RI documentation of its receiver class
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#s">s</a>
+ </td>
+ <td>
+ <strong>S</strong>afety
+ </td>
+ <td>
+ (level number)
+ </td>
+ <td>
+ bumps the safety level (by one or as specified)
+ </td>
+ </tr>
+
+ <tr>
+ <td>
+ <a href="http://lettersrb.com/api#t">t</a>
+ </td>
+ <td>
+ <strong>T</strong>imestamp
+ </td>
+ <td>
+ :time_format
+ </td>
+ <td>
+ prints out the current timestamp
+ </td>
+ </tr>
</table>
See full documentation at http://lettersrb.com/api
-
-
-
-````
-Letter Command Option(s) Description
-a Assert :message :error_class asserts in the context of its receiver or Letters::AssertionError
-b Beep causes your terminal to beep
-c Callstack :message prints the current callstack
-d Debugger passes control to the debugger
-d1 d2 Diff :message :format :stream prints a diff between first and second receivers
-e Empty :message raises a Letters::EmptyError if its receiver is empty
-f File :format :name writes its receiver into a file in a given format
-j Jump (&block) executes its block in the context of its receiver
-k Kill :max raises Letters::KillError after a maximum number of calls
-l Logger :format :level logs its receivers on the available logger instance
-m Mark as taint (true|false) taints (or untaints) its receiver
-n Nil raises a Letters::NilError if its receiver is nil
-o stdOut :format :stream prints its receiver to standard output
-r Ri (method name as symbol) prints RI documentation of its receiver class
-s Safety (level number) bumps the safety level (by one or as specified)
-t Timestamp :time_format prints out the current timestamp
-````
-
-See also full documentation at http://lettersrb.com/api
-
-- `a` (Assert) asserts in the context of its receiver or Letters::AssertionError
-- `b` (Beep) causes your terminal to beep
-- `c` (Callstack) prints the current callstack
-- `d` (Debugger) passes control to the debugger
-- `d1`/`d2` (Diff) prints a diff between first and second receivers
-- `e` (Empty) raises a Letters::EmptyError if its receiver is empty
-- `f` (File) writes its receiver into a file in a given format
-- `j` (Jump) executes its block in the context of its receiver
-- `k` (Kill) raises Letters::KillError after a maximum number of calls
-- `l` (Logger) logs its receivers on the available logger instance
-- `m` (Taint) taints (or untaints) its receiver
-- `n` (Nil) raises a Letters::NilError if its receiver is nil
-- `o` (stdOut) prints its receiver to standard output
-- `r` (Ri) prints RI documentation of its receiver class
-- `s` (Safety) bumps the safety level (by one or as specified)
-- `t` (Timestamp) prints out the current timestamp
-
-See full documentation at http://lettersrb.com/api
Please sign in to comment.
Something went wrong with that request. Please try again.