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

Remove the deprecated .value method #123

Open
francium opened this issue Jun 11, 2023 · 5 comments
Open

Remove the deprecated .value method #123

francium opened this issue Jun 11, 2023 · 5 comments

Comments

@francium
Copy link
Member

#121 deprecated the .value method. This method needs to be removed in a future version. Ideally we'd wait a while so users can have enough time to migrate away on their own.

We could also perhaps change the deprecated method to start throwing an exception and returning None before we remove it completely.

@dolfinus
Copy link

dolfinus commented Dec 3, 2023

Well, at least documentation should be updated first, to mention that this property is deprecated.

@lesnik512
Copy link

Hello, err_value and ok_value is not covered in documentation, if I am not mistaken and they are not annotated by types, so deprecation looks premature

@francium
Copy link
Member Author

francium commented Dec 6, 2023

The field is not being removed in the immediate future.
I'll update the docs...I've opened up #153 to improve the docs as a whole as the current setup with the README isn't very maintainable.

The value field deprecation is however mentioned in the changelog and we've put a deprecation warning whenever anyone tries to use it

DeprecationWarning: Accessing .value on Result type is deprecated, please use .ok_value or '.err_value' instead

@francium
Copy link
Member Author

francium commented Dec 8, 2023

Docs and migration guide have been updated in #159. Thanks for pointing out the issue with the docs.

@francium
Copy link
Member Author

I'm thinking this will be removed when #180 is also done. Enough time will pass by then to remove this deprecated method.

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

No branches or pull requests

3 participants