Skip to content

Deprecate and rename refresh APIs for clarity #532

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

Merged
merged 9 commits into from
Apr 9, 2024

Conversation

amerjusupovic
Copy link
Member

@amerjusupovic amerjusupovic commented Mar 13, 2024

See #350

@amerjusupovic amerjusupovic added this to the v8.0.0 milestone Mar 13, 2024
@amerjusupovic amerjusupovic changed the title Rename refresh APIs for clarity Deprecate old and rename refresh APIs for clarity Mar 13, 2024
@amerjusupovic amerjusupovic changed the title Deprecate old and rename refresh APIs for clarity Deprecate and rename refresh APIs for clarity Mar 13, 2024
@amerjusupovic amerjusupovic linked an issue Mar 13, 2024 that may be closed by this pull request
@@ -27,7 +38,26 @@ public class FeatureFlagOptions
/// <summary>
/// The time after which the cached values of the feature flags expire. Must be greater than or equal to 1 second.
/// </summary>
public TimeSpan CacheExpirationInterval { get; set; } = RefreshConstants.DefaultFeatureFlagsCacheExpirationInterval;
[Obsolete("The CacheExpirationInterval property will be deprecated in a future release. Please use the new `SetFeatureFlagRefreshInterval` method instead. " +
Copy link
Member

Choose a reason for hiding this comment

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

Method has been renamed to SetRefreshInterval

Copy link
Member

Choose a reason for hiding this comment

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

Can we use nameof(SetRefreshInterval) to avoid errors like this in future?

Copy link
Contributor

Choose a reason for hiding this comment

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

property will be deprecated in a future release

Probably just terminology, but it sounds like the API is still not deprecated. How do you like this?

... property is deprecated and will be removed in a future release...

@amerjusupovic amerjusupovic changed the base branch from main to preview April 3, 2024 21:55
@amerjusupovic amerjusupovic force-pushed the ajusupovic/rename-refresh-apis branch 2 times, most recently from 54a4061 to 4fa92eb Compare April 3, 2024 21:56
@amerjusupovic amerjusupovic merged commit 2745270 into preview Apr 9, 2024
@amerjusupovic amerjusupovic deleted the ajusupovic/rename-refresh-apis branch April 9, 2024 21:04
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.

Proposal to rename refresh APIs
4 participants