]> git.xolatile.top Git - public-libhl.git/commitdiff
minor doc edit
authoranon <anon@anon.anon>
Wed, 20 Sep 2023 20:42:06 +0000 (22:42 +0200)
committeranon <anon@anon.anon>
Wed, 20 Sep 2023 20:42:06 +0000 (22:42 +0200)
README.md

index 2ce54d8a597b955b3f767028a21765f6a6d55ece..78ce16012038015ccd1af38cee2cf0f000032b16 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,9 +32,9 @@ Fit a specific token against a string. `render_string()` uses this function inte
 typedef void (*attribute_callback_t)(const char * const string, const int length, void * const attributes);
 ```
 The type used for defining appropriate callbacks for render\_string().
-+ string     - string to be outputed
-+ length     - number of characters that matched a highlighting rule
-+ attributes - arbitrary data associated with the matched rule; intended to hold color/font information for example
++ string     - string to be processed (probably printed)
++ length     - number of characters to be processed from _string_
++ attributes - arbitrary data associated with the matched token; intended to hold color/font information for example; if no token was matched NULL will be passed
 
 
 ```C