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

Obtaining a Logger documentation outdated #456

Closed
mixomat opened this issue Nov 8, 2024 · 3 comments
Closed

Obtaining a Logger documentation outdated #456

mixomat opened this issue Nov 8, 2024 · 3 comments

Comments

@mixomat
Copy link

mixomat commented Nov 8, 2024

As the "old" way of obtaining a KLogger instance via a companion object is now deprecated, the Wiki documentation is now outdated and leads to confusion:

https://github.com/oshai/kotlin-logging/wiki#obtaining-a-logger

Deprecation:

@Deprecated("Use KLogger instead", ReplaceWith("KLogger", "io.github.oshai.kotlinlogging.KLogger"))

Copy link

github-actions bot commented Nov 8, 2024

Thank you for reporting an issue. See the wiki for documentation and slack for questions.

@mixomat
Copy link
Author

mixomat commented Nov 8, 2024

I think it would make sense, to explicitly mark the companion object way as deprecated (or remove it from the documentation).

@oshai
Copy link
Owner

oshai commented Nov 10, 2024

Thanks! I removed it from docs.

Let me know if you find anything else that would help.

@oshai oshai closed this as completed Nov 26, 2024
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

2 participants