From 68876a8230e029895c0c7f121156440c13065973 Mon Sep 17 00:00:00 2001 From: nojhan Date: Sat, 29 May 2021 21:54:14 +0200 Subject: [PATCH] small doc addition remove ambiguity of doc about dump file comment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c7268fd..43343ba 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ Available tags are: The default log format is `"[{name}] {level_letter}:{depth_marks} {msg}\t\t\t\t\t{func} @ {file}:{line}\n"`, it can be overriden at compile time by defining the `CLUTCHLOG_DEFAULT_FORMAT` macro. -The default format of the comment added with the dump macro is +The default format of the first line of comment added with the dump macro is `"# [{name}] {level} in {func} (at depth {depth}) @ {file}:{line}"`. It can be edited with the `format_comment` method. If it is set to an empty string, then no comment line is added.