logger documentation outdated and low detail #74

New Issue

Closed

opened 2024-03-08 12:52:41 +01:00 by cscherrNT · 0 comments

cscherrNT commented

2024-03-08 12:52:41 +01:00

Collaborator

the build methods still use the old names in the documentation
the logger struct / module does not explain in detail how the logger works
Make it very explicit that users should use the macros and that the struct is only for use in contexts where that is not possible
explain the log levels neatly
add a fancy ascii diagram to explain when to use the log levels?
document the pub use statements
explain how logging to file works in detail
write to file example

- [x] the build methods still use the old names in the documentation - [x] the logger struct / module does not explain in detail how the logger works - [x] Make it very explicit that users should use the macros and that the struct is only for use in contexts where that is not possible - [x] explain the log levels neatly - [x] add a fancy ascii diagram to explain when to use the log levels? - [x] document the pub use statements - [x] explain how logging to file works in detail - [x] write to file example