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

Deprecate Throwable related parts #338

Merged
merged 3 commits into from
May 12, 2020
Merged

Deprecate Throwable related parts #338

merged 3 commits into from
May 12, 2020

Conversation

vbuberen
Copy link
Collaborator

📄 Context

Since there is a plan to remove Throwable catching functionality in 4.x we need to prepare users to not introduce breaking changes right away. This PR adds proper deprecation messages, which should both inform and help to switch to valid functions.

📝 Changes

  • Added deprecation messages to public API.

🛠️ How to test

Nothing special for testing. IDE should show suggestions if there is a replacement for deprecated function.

@vbuberen vbuberen requested a review from cortinico May 10, 2020 12:55
@@ -163,4 +163,9 @@ internal class NotificationHelper(val context: Context) {
fun dismissErrorsNotification() {
notificationManager.cancel(ERROR_NOTIFICATION_ID)
}

fun dismissNotifications() {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This fun is a subject to change after removing Throwable stuff.

Copy link
Member

@cortinico cortinico left a comment

Choose a reason for hiding this comment

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

Looks good to me. Minor changes that I will apply as well are:

  1. A note in the readme here https://github.com/ChuckerTeam/chucker#throwables-%EF%B8%8F
  2. A note on this line:
    private const val ERRORS_CHANNEL_ID = "chucker_errors"

    Even though this field is inside an internal class, its effect are public as a Notification channel will be created/used. We should probably note that this will go as well.

@vbuberen
Copy link
Collaborator Author

Good feedback. Thanks. I will address then in this PR.

@vbuberen vbuberen merged commit 1dbffe2 into develop May 12, 2020
@vbuberen vbuberen deleted the deprecate_errors branch May 12, 2020 12:02
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.

2 participants