Open
Conversation
Documentation update by addition of the Set Up section , that describes or provides more details on how to set it up in ones code base.
Goooler
reviewed
Jul 2, 2025
Comment on lines
+125
to
+130
| open class MyProjectApplication : Application() { | ||
| } | ||
| ``` | ||
|
|
||
| ### Step 2 : import the application package | ||
| import android.app.Application |
Contributor
There was a problem hiding this comment.
These steps should be merged.
| override the onCreate() method in your Application class | ||
| ``` | ||
| open class MyProjectApplication : Application() { | ||
| if (BuildConfig.DEBUG) { |
Contributor
There was a problem hiding this comment.
Didn't place them in onCreate here.
| if (BuildConfig.DEBUG) { | ||
| Timber.plant(new DebugTree()); | ||
| } else { | ||
| Timber.plant(new CrashReportingTree()); |
Contributor
There was a problem hiding this comment.
This is not in the public APIs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I added more details on the existing documentation file , focusing on the set up process of Timber once the dependencies have been downloaded.
In the documentation of Timber it was not clear on the implementation process in the application in Kotlin, like described in this Fixes #466 #466 (comment).
To fix that, I added the procedure to implement it programmatically in the users code base. It being a documentation update, the necessity of a test was not in mind.
I added the following under the Set Up section.I updated documentation but i can roll back if needed
Step 1 : Create an Application class that inherits from Application class .
Step 2 : import the application package
Step 3 : override the onCreate() method and initialize the Timber class
override the onCreate() method in your Application class
Step 4 : Define it in your Android Manifest , Application tag
In your application tag, add it as a name attribute :