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

Update docs to reflect methods that raise errors in v5 instead of returning None #1522

Closed
kclowes opened this issue Nov 22, 2019 · 7 comments
Assignees

Comments

@kclowes
Copy link
Collaborator

kclowes commented Nov 22, 2019

  • Version: 5.x

What was wrong?

The docs weren't updated when we started returning a TransactionNotFound or BlockNotFound error instead of None for RPC methods that don't find a transaction.

How can it be fixed?

Docs need to be checked and updated for the following methods:
https://web3py.readthedocs.io/en/stable/v5_migration.html#json-rpc-updates

@ashish10677
Copy link
Contributor

Hi. I want to try to contribute to this issue. Can you please assign it to me?

@kclowes
Copy link
Collaborator Author

kclowes commented Nov 25, 2019

Thanks @ashish10677! Let me know if you have questions!

@ashish10677
Copy link
Contributor

@kclowes I had a very silly doubt. In the documentation, these methods: https://web3py.readthedocs.io/en/stable/v5_migration.html#json-rpc-updates , only one of them has a return type of None mentioned. Do you want me to include the return type of TransactionNotFound or BlockNotFound in all?

@kclowes
Copy link
Collaborator Author

kclowes commented Nov 25, 2019

Yep, let's go ahead and include the return type for all of them.

@ashish10677
Copy link
Contributor

@kclowes I have raised a pull request. I am very new to open source contributions. Please guide me if there are any mistakes that I can fix. I will be happy to do it.

@adamjsawicki
Copy link

@kclowes Can this be closed because of #1527?

@kclowes
Copy link
Collaborator Author

kclowes commented Jan 24, 2020

@swixx Yes! Thanks!

@kclowes kclowes closed this as completed Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants