search

oshai / kotlin-logging

Lightweight Multiplatform logging framework for Kotlin. A convenient and performant logging facade.
Other
2.66k stars 112 forks source link

Obtaining a Logger documentation outdated #456

Open mixomat opened 4 days ago

mixomat commented 4 days ago

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: https://github.com/oshai/kotlin-logging/blob/1f9ecdddc7cc43a03193b431866e7c243491a8d1/src/jvmMain/kotlin/io/github/oshai/kotlinlogging/KLogging.kt#L16

github-actions[bot] commented 4 days ago

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

mixomat commented 4 days ago

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

oshai commented 2 days ago

Thanks! I removed it from docs.

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