Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation #193

Open
zchbndcc9 opened this issue Jul 23, 2019 · 5 comments
Open

Better documentation #193

zchbndcc9 opened this issue Jul 23, 2019 · 5 comments

Comments

@zchbndcc9
Copy link

It would be very nice if there was some more documentation all of the logger apis that are available for use as well as some beginner friendly examples with explanation.

@MaximeGratens
Copy link

Plz up

@philliptaylorpro
Copy link

It's not obvious from the README what the actual output of that code is.

Ideally logging is always executed and written to disk even if something afterwards blows up inside the program so you can debug it. Whilst side-effects are bad, you can't undo time spent by the cpu so for this reason I assume all log lines are written to disk immediately?

@ChristopherDavenport
Copy link
Member

@philliptaylorpro Which backend are you referring to? In Slf4j backend, that depends on how the base logger is configured. They are immediately submitted to the backend logger. However then that logger controls when the unit is returned back to the algebra.

@kubukoz
Copy link
Member

kubukoz commented Jun 30, 2021

I have some ideas for improving the documentation. The testing/noop/writer loggers, structured logging, self aware logging - each of these could get a section. I can spend some time on this (just a couple sentences each, probably everything can fit on the main page of the microsite).

@yamin-oanda
Copy link

Did any of this planned documentation end up getting added?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants