Merge pull request #310 from vpeil/pr/issue_251

expand documentation, GH #251

lib/Catmandu/Fix/lookup.pm

@@ -93,13 +93,30 @@ Catmandu::Fix::lookup - change the value of a HASH key or ARRAY index by
 looking up its value in a dictionary
 
 =head1 SYNOPSIS
-
-   lookup(foo.bar, dictionary.csv)
-   lookup(foo.bar, dictionary.csv, sep_char: |)
-   # delete value if the lookup fails:
-   lookup(foo.bar, dictionary.csv, delete: 1)
-   # use a default value if the lookup fails:
-   lookup(foo.bar, dictionary.csv, default: 'default value')
+    # dictionary.csv
+    # id,planet
+    # 1,sun
+    # 2,earth
+    # 3,moon
+
+    # values found in the dictionary.csv will be replaced
+    # {foo => {bar => 2}}
+    lookup(foo.bar, dictionary.csv)
+    # {foo => {bar => 'earth'}}
+
+    # values not found will be kept
+    # {foo => {bar => 232}}
+    lookup(foo.bar, dictionary.csv)
+    # {foo => {bar => 232}}
+
+    # in case you have a different seperator
+    lookup(foo.bar, dictionary.csv, sep_char: |)
+
+    # delete value if the lookup fails:
+    lookup(foo.bar, dictionary.csv, delete: 1)
+
+    # use a default value if the lookup fails:
+    lookup(foo.bar, dictionary.csv, default: 'default value')
 
 =head1 SEE ALSO