Relocate web3.api and shuffle docs #1290
Conversation
njgheorghita
force-pushed
the
relocate-web3-api-version
branch
2 times, most recently
from
088e603 to
d4c4157
Compare
web3/version.py
Outdated
| @@ -44,8 +44,7 @@ def ethereum(self): | |||
| class Version(Module): | |||
| @property | |||
| def api(self): | |||
| from web3 import __version__ | |||
| return __version__ | |||
| raise DeprecationWarning("This method has been deprecated as of EIP 1474.") | |||
There was a problem hiding this comment.
I know there was a comment about raising warnings vs not in a past PR, but why are we using one over the other? Also, maybe this warning should say something like: This method has been deprecated ... Please use web3.api instead?
There was a problem hiding this comment.
Good call on the warning msg! re other stuff: from here
So warnings don't break codeflow, they just dump information out so a user who's watching for them knows something is going away. Using the raise syntax breaks code flow so they are two separate mechanisms. These can be easy to mixup since the exception class is called
DeprecationWarningbut they are two different mechanisms that use the same class.
warning.warn(...) - for v4
raise DeprecationWarning - for v5
njgheorghita
force-pushed
the
relocate-web3-api-version
branch
from
d4c4157 to
a8bec1c
Compare
What was wrong?
Deprecate
web3.versionand move non-standard jsonrpc endpoints to parity/geth specific documentation pages.see conversation here
Cute Animal Picture