Overview documentation overhaul #1681
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wolovim
force-pushed
the
onboarding-docs-pt4
branch
from
fb8cca5
to
5d556d4
Compare
wolovim
force-pushed
the
onboarding-docs-pt4
branch
from
5d556d4
to
441ee67
Compare
pipermerriam
approved these changes
Jul 8, 2020
| - :meth:`web3.eth.uninstallFilter() <web3.eth.Eth.uninstallFilter>` | ||
| - :meth:`web3.eth.getLogs() <web3.eth.Eth.getLogs>` | ||
| - :meth:`Contract.events.your_event_name.createFilter() <web3.contract.Contract.events.your_event_name.createFilter>` | ||
| - :meth:`Contract.events.your_event_name.build_filter() <web3.contract.Contract.events.your_event_name.build_filter>` |
There was a problem hiding this comment.
Maybe also add your_event.processReceipt, your_event.processLog, your_event.getLogs
There was a problem hiding this comment.
Looks like a small ticket worth of work to add a getLogs method to the events documentation, plus sort out links for processLog and processReceipt. The latter two get lumped under the same top-level link without links of their own (ContractEvents.myEvent). Will look to sort that out in a subsequent PR, so I can start this beta release.
carver
approved these changes
Jul 8, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong?
The existing Overview documentation provides an introduction to Providers, then dumps out the base class API, e.g., utility methods for type conversions, address helpers, etc.
How was it fixed?
I thought the Overview page would be put to better use (i.e., answer more typical support questions) if it instead gave a tour of the features in the lib. I believe this will be useful for orienting newcomers, but I also built the reference page I wished existed; I included much of the API, broken into usage category.
There's a lot of content and its a big departure from the current state of things. Feedback appreciated!
Generated docs preview: https://web3py--1681.org.readthedocs.build/en/1681/
Todo:
Cute Animal Picture