docs: Add examples to documentation
This commit is contained in:
@@ -15,10 +15,23 @@ Parse log level from text representation to level number
|
||||
|
||||
Parse log level from text representation to level number
|
||||
|
||||
#### Example
|
||||
|
||||
```bash
|
||||
# Parse lower case log level
|
||||
parse_log_level "info"
|
||||
# Parse upper case log level
|
||||
parse_log_level "ERROR"
|
||||
```
|
||||
|
||||
#### Arguments
|
||||
|
||||
* **$1** (string): Log level to parse
|
||||
|
||||
#### Variables set
|
||||
|
||||
* **LOG_LEVEL** (the): global log level to use in the script
|
||||
|
||||
#### Output on stdout
|
||||
|
||||
* numeric log level
|
||||
@@ -27,6 +40,14 @@ Parse log level from text representation to level number
|
||||
|
||||
Log output on a given level, checks if $LOG_LEVEL, if not set defaults to INFO
|
||||
|
||||
#### Example
|
||||
|
||||
```bash
|
||||
# Log a message on info level
|
||||
log "$LOG_INFO" "this is a info message"
|
||||
log "LOG_DEBUG" "i am only visible when \$LOG_LEVEL is debug"
|
||||
```
|
||||
|
||||
#### Arguments
|
||||
|
||||
* **$1** (number): Numeric log level
|
||||
|
||||
Reference in New Issue
Block a user