deavmi/dlog
deavmi
/
dlog
mirror of https://github.com/deavmi/dlog.git
1
0
Fork 0
Code Issues Releases Activity

Added section explaining the context array

This commit is contained in:
Tristan B. Velloza Kildaire 2021-12-23 14:49:16 +02:00
parent 5eb73a3fbc
commit 2663711b4a
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -84,8 +84,21 @@ Additional information, besides the text being logged itself (this is the `strin
the contents of which are described below:
1. `context[0]`
TODO
* This contains `__FILE_FULL_PATH__` which is the full path (absolute) to the source file where `log()` was called
2. `context[1]`
* This contains `__FILE__` which is the path (starting at `source/` to the source file where `log()` was called
3. `context[2]`
* This contains a stringified version of `__LINE__` which is the line number of the call to `log()`
4. `context[3]`
* This contains `__MODULE__` which is the name of the module the call to `log()` appeared in
5. `context[4]`
* This contains `__FUNCTION__` which is the name of the function `log()` was called in
6. `context[5]`
* This contains `__PRETTY_FUNCTION__` which is the same as above but with type information
7. `context[5..X]`
* This contains optional extras that were set when the `log()` function was called with the `contextExtras` set
* Example: `log("Hello world", contextExtras=[this])`
## License
LGPLv2
LGPLv2