From ad73aa20f5c1599b7e6e2eab92eaf12f630ab3f5 Mon Sep 17 00:00:00 2001
From: Jens Wille <jens.wille@hbz-nrw.de>
Date: Wed, 2 Oct 2024 15:24:11 +0200
Subject: [PATCH] Update documentation for `log()` Fix function. (#366)

---
 README.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 2d3e3424..4cb5b10b 100644
--- a/README.md
+++ b/README.md
@@ -169,20 +169,23 @@ include("<path>"[, <dynamicLocalVariables>...])
 [Java Code](https://github.com/search?type=code&q=repo:metafacture/metafacture-fix+path:FixMethod.java+"+include+{")
 
 ##### `log`
-Send a message to the logs.
+
+Sends a message to the logs.
 
 Parameters:
 
-- `logMessage` specifies the message that should be logged.
+- `logMessage` (required): Message to log.
 
 Options:
 
-- `level` sets one of the following log levels: INFO, DEBUG, ERROR, WARN (Default: INFO).
+- `level`: Log level to log at (one of `DEBUG`, `INFO`, `WARN` or `ERROR`). (Default: `INFO`)
 
 ```perl
-log(“<logMessage>”,level:DEBUG)
+log("<logMessage>"[, level: "<logLevel>"])
 ```
 
+[Java Code](https://github.com/search?type=code&q=repo:metafacture/metafacture-fix+path:FixMethod.java+"+log+{")
+
 ##### `nothing`
 
 Does nothing. It is used for benchmarking in Catmandu.