Browse Source

Update documentation;

bjorn 10 years ago
parent
commit
151bf6f8ca
1 changed files with 14 additions and 13 deletions
  1. 14 13
      doc/README.md

+ 14 - 13
doc/README.md

@@ -13,7 +13,7 @@ RxLua
   - [fromRange](#fromrangeinitial-limit-step)
   - [fromRange](#fromrangeinitial-limit-step)
   - [fromTable](#fromtabletable-iterator-keys)
   - [fromTable](#fromtabletable-iterator-keys)
   - [fromCoroutine](#fromcoroutinecoroutine)
   - [fromCoroutine](#fromcoroutinecoroutine)
-  - [dump](#dumpname)
+  - [dump](#dumpname-formatter)
   - [changes](#changescomparator)
   - [changes](#changescomparator)
   - [combine](#combineobservables-combinator)
   - [combine](#combineobservables-combinator)
   - [compact](#compact)
   - [compact](#compact)
@@ -26,11 +26,11 @@ RxLua
   - [last](#last)
   - [last](#last)
   - [map](#mapcallback)
   - [map](#mapcallback)
   - [max](#max)
   - [max](#max)
-  - [min](#min)
   - [merge](#mergesources)
   - [merge](#mergesources)
+  - [min](#min)
   - [pack](#pack)
   - [pack](#pack)
   - [partition](#partitionpredicate)
   - [partition](#partitionpredicate)
-  - [pluck](#pluckkey)
+  - [pluck](#pluckkeys)
   - [reduce](#reduceaccumulator-seed)
   - [reduce](#reduceaccumulator-seed)
   - [reject](#rejectpredicate)
   - [reject](#rejectpredicate)
   - [skip](#skipn)
   - [skip](#skipn)
@@ -176,13 +176,14 @@ Creates an Observable that produces values when the specified coroutine yields.
 
 
 ---
 ---
 
 
-#### `:dump(name)`
+#### `:dump(name, formatter)`
 
 
 Subscribes to this Observable and prints values it produces.
 Subscribes to this Observable and prints values it produces.
 
 
 | Name | Type | Default | Description |
 | Name | Type | Default | Description |
 |------|------|---------|-------------|
 |------|------|---------|-------------|
 | `name` | string (optional) |  | Prefixes the printed messages with a name. |
 | `name` | string (optional) |  | Prefixes the printed messages with a name. |
+| `formatter` | function (optional) | tostring | A function that formats one or more values to be printed. |
 
 
 ---
 ---
 
 
@@ -283,12 +284,6 @@ Returns a new Observable that produces the maximum value produced by the origina
 
 
 ---
 ---
 
 
-#### `:min()`
-
-Returns a new Observable that produces the minimum value produced by the original.
-
----
-
 #### `:merge(sources)`
 #### `:merge(sources)`
 
 
 Returns a new Observable that produces the values produced by all the specified Observables in the order they are produced.
 Returns a new Observable that produces the values produced by all the specified Observables in the order they are produced.
@@ -299,6 +294,12 @@ Returns a new Observable that produces the values produced by all the specified
 
 
 ---
 ---
 
 
+#### `:min()`
+
+Returns a new Observable that produces the minimum value produced by the original.
+
+---
+
 #### `:pack()`
 #### `:pack()`
 
 
 Returns an Observable that produces the values of the original inside tables.
 Returns an Observable that produces the values of the original inside tables.
@@ -315,13 +316,13 @@ Returns two Observables: one that produces values for which the predicate return
 
 
 ---
 ---
 
 
-#### `:pluck(key)`
+#### `:pluck(keys)`
 
 
-Returns a new Observable that produces values computed by extracting the given key from the tables produced by the original.
+Returns a new Observable that produces values computed by extracting the given keys from the tables produced by the original.
 
 
 | Name | Type | Default | Description |
 | Name | Type | Default | Description |
 |------|------|---------|-------------|
 |------|------|---------|-------------|
-| `key` | function |  | The key to extract from the table. |
+| `keys` | string... |  | The key to extract from the table. Multiple keys can be specified to recursively pluck values from nested tables. |
 
 
 ---
 ---