Comments (2)
While converting to RTD, we got some reasonable feedback at Devcon4 about what's not working well, currently:
The quick start doesn't actually show how to instantiate a contract or call contract methods, just send basic transactions. Compare that with the documentation on pyethereum tester, which, while extremely scant and not nearly verbose enough, at least tells you how to do what you want to do: https://github.com/ethereum/pyethereum/wiki/Using-pyethereum.tester
Yup, definitely need more content here.
The Eth-Tester readme is also too long and doesn't actually tell you anything. For example, I can read the source if I want to know what the function parameters are to the EthereumTester.take_snapshot function - that level of documentation belongs in the docstring above the function NOT in a ReadMe.
I think the best way to do this is to add docstrings, and have those get auto-inserted into the RTD API docs. So we will end up with low-level docs in RTD, but they will be auto-generated from the source docs.
from eth-tester.
cc @AKewlBreeze this might be a good one for you.
from eth-tester.
Related Issues (20)
- Legacy properties required and set to null instead of allowed to be excluded HOT 2
- `block_number` genesis parameter removed HOT 5
- Testing without London enabled HOT 2
- MockBackend allow default account data configuration
- feat request: set_balance method
- Problems with PyEVMBackend Berlin configuration HOT 1
- feature request: Add `set_code()` API method
- Add typing HOT 2
- Build with `py-evm` feature fails on Python3.11/MacOS HOT 2
- Have error formatting comply with the JSON-RPC error format HOT 3
- ContractLogicError from custom exception contains stringified bytes instead of hex str
- Feature request: eth_feeHistory RPC endpoint HOT 1
- Support HDPath for Mnemonic
- Surprising execution behavior when calling smart contract functions HOT 2
- Implement `eth_getStorageAt` HOT 2
- ERROR: Could not build wheels for pyethash, which is required to install pyproject.toml-based projects
- ETHEREUM TESTER
- feat: Python 3.12 support HOT 1
- eth_fee_history works incorrectly
- Support eth_createAccessList RPC implementation
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from eth-tester.