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

Add LoggerFactory docs #642

Merged
merged 6 commits into from
May 7, 2022
Merged

Add LoggerFactory docs #642

merged 6 commits into from
May 7, 2022

Conversation

danicheg
Copy link
Member

@danicheg danicheg commented Apr 26, 2022

These docs are based on work made by @lorandszakacs in #421. So all credits go to them.
This covers a little part of the LoggerFactory, a basic functionality at most. It'd be great to complete it subsequently.

@danicheg
Copy link
Member Author

I will be pretty happy if @hamnis and @lorandszakacs can have to look at this.

@hamnis
Copy link
Contributor

hamnis commented Apr 26, 2022

Great stuff!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Comment on lines +92 to +94
* you have control of loggers creation, and you can even add in whatever custom
functionality you need for your applications here. E.g. create loggers that also push logs
to some external providers by giving a custom implementation of this trait.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* you have control of loggers creation, and you can even add in whatever custom
functionality you need for your applications here. E.g. create loggers that also push logs
to some external providers by giving a custom implementation of this trait.
* you have control of loggers creation, and you can even add in whatever custom
functionality you need for your applications here by giving a custom implementation of this trait. For example, create loggers that also push logs to some external providers.

describe the way before talking about examples

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@lorandszakacs
Copy link
Member

Looks good, I'd incorporate @FunFunFine's suggestions though

@danicheg
Copy link
Member Author

danicheg commented May 6, 2022

I've tackled most of the comments, so probably this PR is quite ok to get merged. If anyone wants to continue improving these docs, don't be shy and open a PR.

@danicheg danicheg merged commit 5addafb into typelevel:main May 7, 2022
@danicheg danicheg deleted the logger-factory branch May 7, 2022 00:00
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

Successfully merging this pull request may close these issues.

4 participants