Skip to content

Fix typo in RemindingNotifier interval setter#5397

Open
codingkiddo wants to merge 3 commits into
codecentric:masterfrom
codingkiddo:fix/reminding-notifier-interval-typo
Open

Fix typo in RemindingNotifier interval setter#5397
codingkiddo wants to merge 3 commits into
codecentric:masterfrom
codingkiddo:fix/reminding-notifier-interval-typo

Conversation

@codingkiddo
Copy link
Copy Markdown

Fixes a typo in RemindingNotifier's check reminder interval setter.

The existing public method name setCheckReminderInverval contains a typo. This change adds the correctly spelled setCheckReminderInterval method and keeps the existing misspelled method as a deprecated forwarder for backward compatibility.

Also updated sample configuration, documentation examples, and tests to use the corrected setter name.

Tests run:

  • mvn -pl spring-boot-admin-server -Dtest=RemindingNotifierTest test
  • git diff --check

Signed-off-by: Vinod Kumar <codingkiddo@gmail.com>
@codingkiddo codingkiddo requested a review from a team as a code owner May 27, 2026 07:30
@cdprete
Copy link
Copy Markdown
Contributor

cdprete commented May 27, 2026

I'm not a mantainer of the project, so my opinion here counts very little, but the fix is so trivial for whoever is using the feature that I wouldn't bother to keep the mistyped method, to be honest.

@codingkiddo
Copy link
Copy Markdown
Author

I'm not a mantainer of the project, so my opinion here counts very little, but the fix is so trivial for whoever is using the feature that I wouldn't bother to keep the mistyped method, to be honest.

Thanks for taking a look.

I kept the misspelled setter as a deprecated forwarder because this is a public API method and removing it could break existing users. I’m happy to remove the compatibility method if the maintainers prefer a direct rename only.

@cdprete
Copy link
Copy Markdown
Contributor

cdprete commented May 27, 2026

I kept the misspelled setter as a deprecated forwarder because this is a public API method and removing it could break existing users. I’m happy to remove the compatibility method if the maintainers prefer a direct rename only.

Understandable and, depending on the type of the API and the effort to migrate to the new one, I would have potentially done the same.
On the other end, keeping the deprecated method arises the concern about when it's safe to drop it.
In the next minor version 4.1.0? In the next major version 5.0.0?

@codingkiddo
Copy link
Copy Markdown
Author

I kept the misspelled setter as a deprecated forwarder because this is a public API method and removing it could break existing users. I’m happy to remove the compatibility method if the maintainers prefer a direct rename only.

Understandable and, depending on the type of the API and the effort to migrate to the new one, I would have potentially done the same. On the other end, keeping the deprecated method arises the concern about when it's safe to drop it. In the next minor version 4.1.0? In the next major version 5.0.0?

That’s a fair concern.

If we keep the deprecated forwarder, I’d suggest treating it as a compatibility bridge for the 4.x line and removing it in the next major version, 5.0.0, rather than 4.1.0. Since the misspelled method is already part of the public API, removing it in a minor release could still surprise users who call it directly.

That said, I’m also fine to simplify this PR and remove the deprecated method if the maintainers prefer not to carry the compatibility API for this typo.

@cdprete
Copy link
Copy Markdown
Contributor

cdprete commented May 28, 2026

Up to the team ;)

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