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

Mark public methods in (I)HaveIBeenPwnedClient without cancellation tokens as obsolete #65

Open
akamsteeg opened this issue Jun 25, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@akamsteeg
Copy link
Owner

akamsteeg commented Jun 25, 2022

Currently, all public methods in HaveIBeenPwnedClient have two versions: One with a CancellationToken and one without. In the modern .NET world, there's a big push to either requiring cancellation tokens (or a explicit CancellationToken.None when cancelling is not important) or have an optional parameter with the cancellation token with a default value.

I prefer being as explicit in code as possible so for vFuture I'd like to remove the methods without a cancellation token. That means that in coming v6.x/V7 upgrades, we must mark the methods in (I)HaveIBeenPwnedClient without a CancellationToken with an ObsoleteAttribute with an appropriate worded warning.

We must also update the IntelliSense docs on the methods with a CancellationToken that CancellationToken.None can be used to when cancellation is not required or a cancellation token source is not available.

@akamsteeg akamsteeg added enhancement New feature or request good first issue Good for newcomers labels Jun 25, 2022
@akamsteeg akamsteeg added this to the 6.x milestone Jun 25, 2022
@akamsteeg akamsteeg modified the milestones: 6.x, 7.x Sep 30, 2022
@akamsteeg akamsteeg modified the milestones: 7.0, v7.x Nov 13, 2022
@akamsteeg akamsteeg modified the milestones: v8.0, vFuture Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant