Skip to content

Commit 99fb697

Browse files
authored
More formatting in reference.md (#45)
To make it fit better and without scrolling, plus some added consistency to the outputs.
1 parent b23b21f commit 99fb697

File tree

1 file changed

+76
-59
lines changed

1 file changed

+76
-59
lines changed

doc/reference.md

Lines changed: 76 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
</thead>
1111
<tbody>
1212
<tr>
13-
<td><b>functions</b></td>
13+
<td align="center"><b>Functions</b></td>
1414
<td>
1515
<pre>
1616
<code>
@@ -39,7 +39,7 @@ foo one two
3939
</tr>
4040

4141
<tr>
42-
<td><b>switch statement</b></td>
42+
<td align="center"><b>Switch statement</b></td>
4343
<td>
4444
<pre>
4545
<code>
@@ -68,7 +68,7 @@ esac
6868
</tr>
6969

7070
<tr>
71-
<td><b>easy if statements</b></td>
71+
<td align="center"><b>Easy if statements</b></td>
7272
<td>
7373
<pre>
7474
<code>
@@ -78,10 +78,14 @@ else
7878
echo "bar"
7979
</code>
8080
<code>
81-
if not $j is "foo" and $x is "bar"
82-
if $j is "foo" or $j is "xfoo"
83-
if $j > $y and $j != $y or $j >= $y
84-
echo "foo"
81+
if not false and true
82+
if true or false
83+
echo "foo"
84+
</code>
85+
<code>
86+
if $x > $y
87+
if $a < $b
88+
echo "bar"
8589
</code>
8690
</pre>
8791
</td>
@@ -95,11 +99,16 @@ else
9599
fi
96100
</code>
97101
<code>
98-
if [[ ! "$j" == "foo" && "$x" == "bar" ]]; then
99-
if [[ "$j" == "foo" || "$j" == "xfoo" ]]; then
100-
if [[ "$j" -gt "$y" && "$j" -ne "$y" || "$j" -ge "$y" ]]; then
101-
echo "foo"
102-
fi
102+
if ! false && true; then
103+
if true || false; then
104+
echo 10
105+
fi
106+
fi
107+
</code>
108+
<code>
109+
if [[ "$x" -gt "$y" ]]; then
110+
if [[ "$a" -lt "$b" ]]; then
111+
echo "bar"
103112
fi
104113
fi
105114
</code>
@@ -108,7 +117,7 @@ fi
108117
</tr>
109118

110119
<tr>
111-
<td><b>associative array</b></td>
120+
<td align="center"><b>Associative arrays</b></td>
112121
<td>
113122
<pre>
114123
<code>
@@ -146,7 +155,7 @@ echo "${foo["bar"]}"
146155
</tr>
147156

148157
<tr>
149-
<td><b>indexed array</b></td>
158+
<td align="center"><b>Indexed array</b></td>
150159
<td>
151160
<pre>
152161
<code>
@@ -183,7 +192,7 @@ echo "${bla[0]}"
183192
</tr>
184193

185194
<tr>
186-
<td><b>read file line by line (shared scope)</b></td>
195+
<td align="center"><b>Read file line by line (shared scope)</b></td>
187196
<td>
188197
<pre>
189198
<code>
@@ -204,7 +213,7 @@ for line from $selfpath/foo.txt
204213
</tr>
205214

206215
<tr>
207-
<td><b>regex</b></td>
216+
<td align="center"><b>Regex</b></td>
208217
<td>
209218
<pre>
210219
<code>
@@ -217,7 +226,7 @@ if $f match ^([f]oo)
217226
<pre>
218227
<code>
219228
# extended pattern matching
220-
# (google 'extglob' for more
229+
# (google 'extglob' for more)
221230
</code>
222231
<code>
223232
if [[ "$f" =~ ^([f]oo) ]]; then
@@ -229,7 +238,7 @@ fi
229238
</tr>
230239

231240
<tr>
232-
<td><b>require module</b></td>
241+
<td align="center"><b>Requiring modules</b></td>
233242
<td>
234243
<pre>
235244
<code>
@@ -253,7 +262,7 @@ source foo.bash
253262
</tr>
254263

255264
<tr>
256-
<td><b>empty / isset checks</b></td>
265+
<td align="center"><b>empty / isset checks</b></td>
257266
<td>
258267
<pre>
259268
<code>
@@ -288,29 +297,30 @@ foo "$@"
288297
</tr>
289298

290299
<tr>
291-
<td><b>mappipe unwraps a pipe</b></td>
300+
<td align="center"><b>mappipe unwraps a pipe</b></td>
292301
<td>
293302
<pre>
294303
<code>
295-
myfunc()
304+
fn()
296305
echo "value=$1"
297306
</code>
298307
<code>
299-
echo -e "foo\nbar\n" | mappipe myfunc
308+
echo -e "a\nb\n" | mappipe fn
300309
</code>
301310
</pre>
302311
</td>
303312
<td>
304313
<pre>
305314
<code>
306-
# outputs: 'value=foo' and 'value=bar'
315+
# outputs: value=a
316+
# value=b
307317
</code>
308318
</pre>
309319
</td>
310320
</tr>
311321

312322
<tr>
313-
<td><b>easy math</b></td>
323+
<td align="center"><b>Easy math</b></td>
314324
<td>
315325
<pre>
316326
<code>
@@ -323,24 +333,24 @@ math '9 / 2' 4
323333
<pre>
324334
<code>
325335
# outputs: '4' and '4.5000'
326-
# NOTE: the second requires bc
327-
# to be installed for floatingpoint math
336+
# NOTE: floating point math
337+
# requires bc
328338
</code>
329339
</pre>
330340
</td>
331341
</tr>
332342

333343
<tr>
334-
<td><b>Easy async</b></td>
344+
<td align="center"><b>Easy async</b></td>
335345
<td>
336346
<pre>
337347
<code>
338-
myfunc()
348+
fn()
339349
sleep 1s
340350
echo "one"
341351
</code>
342352
<code>
343-
await myfunc 123 then
353+
await fn 123 then
344354
echo "async done"
345355
</code>
346356
</pre>
@@ -356,19 +366,17 @@ await myfunc 123 then
356366
</tr>
357367

358368
<tr>
359-
<td><b>Easy async pipe</b></td>
369+
<td align="center"><b>Easy async pipe</b></td>
360370
<td>
361371
<pre>
362372
<code>
363-
myfunc()
373+
fn()
364374
sleep 1s
365375
echo "one"
366376
</code>
367377
<code>
368-
await myfunc 123 then |
378+
await fn 123 then |
369379
cat -
370-
</code>
371-
<code>
372380
when done
373381
echo "async done"
374382
</code>
@@ -385,17 +393,17 @@ when done
385393
</tr>
386394

387395
<tr>
388-
<td><b>Easy async pipe (per line)</b></td>
396+
<td align="center"><b>Easy async pipe (per line)</b></td>
389397
<td>
390398
<pre>
391399
<code>
392-
myfunc()
400+
fn()
393401
sleep 1s
394402
echo "one"
395403
echo "two"
396404
</code>
397405
<code>
398-
await myfunc 123 then for line
406+
await fn 123 then for line
399407
echo "line: $*"
400408
when done
401409
echo "async done"
@@ -414,13 +422,16 @@ when done
414422
</tr>
415423

416424
<tr>
417-
<td><b>JSON decode</b></td>
425+
<td align="center"><b>JSON decode</b></td>
418426
<td>
419427
<pre>
420428
<code>
421-
json={}
422-
echo '{"a": {"b": "c"}}' | json_decode json
423-
echo $json['a-b']
429+
obj={}
430+
json='{"a": {"b": "c"}}'
431+
</code>
432+
<code>
433+
echo "$json" | json_decode obj
434+
echo $obj['a-b']
424435
</code>
425436
</pre>
426437
</td>
@@ -434,51 +445,56 @@ echo $json['a-b']
434445
</tr>
435446

436447
<tr>
437-
<td><b>FP: curry</b></td>
448+
<td align="center"><b>FP: curry</b></td>
438449
<td>
439450
<pre>
440451
<code>
441-
myfunc()
452+
fn()
442453
echo "1=$1 2=$2"
443454
</code>
444455
<code>
445-
curry curriedfunc abc
446-
echo -e "foo\nbar\n" | mappipe curriedfunc
456+
curry fnc a
457+
echo -e "b\nc\n" | mappipe fnc
447458
</code>
448459
</pre>
449460
</td>
450461
<td>
451462
<pre>
452463
<code>
453-
# outputs: '1=abc 2=foo' and '1=abc 2=bar'
464+
# outputs: 1=a 2=b
465+
# 1=a 2=c
454466
</code>
455467
</pre>
456468
</td>
457469
</tr>
458470

459471
<tr>
460-
<td><b>FP: array values, keys</b></td>
472+
<td align="center"><b>FP: array values, keys</b></td>
461473
<td>
462474
<pre>
463475
<code>
464476
foo={}
465477
foo["one"]="foo"
466478
foo["two"]="bar"
467-
map foo keys # prints key per line
468-
map foo values # prints value per line
479+
map foo keys
480+
map foo values
469481
</code>
470482
</pre>
471483
</td>
472484
<td>
473485
<pre>
474486
<code>
487+
# outputs: one
488+
# two
489+
# foo
490+
# bar
475491
</code>
476492
</pre>
477493
</td>
478494
</tr>
479495

480496
<tr>
481-
<td><b>FP: map</b></td>
497+
<td align="center"><b>FP: map</b></td>
482498
<td>
483499
<pre>
484500
<code>
@@ -502,49 +518,50 @@ map foo printitem
502518
</tr>
503519

504520
<tr>
505-
<td><b>FP: pick</b></td>
521+
<td align="center"><b>FP: pick</b></td>
506522
<td>
507523
<pre>
508524
<code>
509525
foo={}
510526
bar={}
511527
foo["one"]="foo"
512528
bar["foo"]="123"
513-
map foo values | unpipe pick bar
529+
map foo values |
530+
mappipe pick bar
514531
</code>
515532
</pre>
516533
</td>
517534
<td>
518535
<pre>
519536
<code>
520-
# outputs: '123'
537+
# outputs: 123
521538
</code>
522539
</pre>
523540
</td>
524541
</tr>
525542

526543
<tr>
527-
<td><b>FP: compose</b></td>
544+
<td align="center"><b>FP: compose</b></td>
528545
<td>
529546
<pre>
530547
<code>
531-
funcA()
548+
fnA()
532549
echo "($1)"
533550
</code>
534551
<code>
535-
funcB()
552+
fnB()
536553
echo "|$1|"
537554
</code>
538555
<code>
539-
compose decorate_string funcA funcB
540-
decorate_string "foo"
556+
compose decorate fnA fnB
557+
decorate "foo"
541558
</code>
542559
</pre>
543560
</td>
544561
<td>
545562
<pre>
546563
<code>
547-
# outputs: '(|foo|)'
564+
# outputs: (|foo|)
548565
</code>
549566
</pre>
550567
</td>

0 commit comments

Comments
 (0)