Skip to content

Commit 7fb37ee

Browse files
committed
Doc tweaks
1 parent 9f47659 commit 7fb37ee

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,23 @@ E.g. you can use `variable=$(regexp_nocase expression)` (functional form) or `se
3838
- `i2a` *{integer}*
3939
Returns the character (string of length 1) of ascii code *{integer}*.
4040
E.g: `i2a 65` returns `A`
41+
4142
Forms: functional, set
4243

4344
- `a2i` *{character}*
4445
Returns the decimal ascii code (integer) of the character (string of length 1) parameter.
4546
E.g: `a2i "A"` returns `65`
47+
4648
Forms: functional, set
4749

4850
- `x2a`*{hexadecimal}* Returns the character (string of length 1) of ascii code *{hexadecimal}*.
4951
E.g:`x2a 41`returns`A`
52+
5053
Forms: functional, set
5154

5255
- `a2x` *{character}* Returns the hexadecimal ascii code (integer) of the character (string of length 1) parameter.
5356
E.g: `x2i "A"` returns `41`
57+
5458
Forms: functional, set
5559

5660
#### src/regexp_nocase.sh
@@ -60,6 +64,7 @@ E.g. you can use `variable=$(regexp_nocase expression)` (functional form) or `se
6064
E.g: `a` becomes `[aA]`, `a.b` becomes `[aA].[bB]`, `[a-c]` becomes `[a-cA-C]`, `[[:lower:]]` becomes `[[:alpha:]]`, etc...
6165

6266
This is very useful when you want to match a regular expression with some parts matching with case, and others not, because bash lacks [inline regexp modifiers](https://www.rexegg.com/regex-modifiers.html) such as `(?i)`.
67+
6368
Forms: functional, set.
6469

6570
#### src/regexp_quote.sh
@@ -69,12 +74,14 @@ E.g. you can use `variable=$(regexp_nocase expression)` (functional form) or `se
6974
Takes a regular expression (as used in `[[ =~ ]]`) as only parameter, and returns a modified version that quotes (or escape) special characters to make them match literally. A bit like `fgrep`.
7075
E.g: `a.b` becomes `a[.]b`, `x*[a-c]` becomes `x[*][[]a-c[]]`, etc...
7176
This is very useful when you want to match a regular expression with some parts matching literally, and other parts matching as regexps.
77+
7278
Forms: functional, set.
7379

7480
- `regexp_quote_nocase` *{regular-expression}*
7581

7682
As `regexp_quote` above, but the returned regular expression is made case-independent.
7783
E.g: `a.b` becomes`[aA][.][bB]`,` x*[a-c]`becomes`[xX][*][[][aA]-[xX][cC][]]`, etc...
84+
7885
Forms: functional, set.
7986

8087
Only in "set" form:
@@ -88,7 +95,7 @@ Only in "set" form:
8895

8996
- `trim` *{string}*
9097
Removes the spaces or tabs at the start and end of the *{string}* argument and returns it
91-
Forms: functional, set, var.
98+
- Forms: functional, set, var.
9299

93100
### Library test suite (in tests/)
94101

0 commit comments

Comments
 (0)