docs: add doctesting to userguides #2024
Conversation
docs/conf.py
Outdated
| ) | ||
|
|
||
| doctest_global_setup = ''' | ||
| from ape import accounts |
There was a problem hiding this comment.
we likely want to import all the ape top-level stuff here.
There was a problem hiding this comment.
that works! a good use-case for the *-style import
docs/conf.py
Outdated
| doctest_global_setup = ''' | ||
| from ape import accounts | ||
|
|
||
| my_account_alias = accounts.test_accounts[0] |
There was a problem hiding this comment.
question: are we able to have individual test setups? something like this doesnt need to be global
issue: i commented elsewhere, but this is supposed to be an alias, not an account, and i think itll likely always fail, ideally we ignore it because it is like a "task failed successfully" kinda moment. but otherwise, you could try my_account_alias = accounts.test_accounts[0].alias
There was a problem hiding this comment.
Yes we can do individual test setups. I was trying this out to test if it would be nicer for this to have in a global setup but I'll switch it to individual since it's currently not being used for more than one test.
docs/userguides/projects.md
Outdated
| ``` | ||
|
|
||
| **NOTE**: You can also deploy contracts from the container itself: | ||
|
|
||
| ```python | ||
| from ape import accounts, project | ||
|
|
||
| account = accounts.load("my_account_alias") | ||
| account = accounts.load(f"{my_account_alias}") |
There was a problem hiding this comment.
this will likely always fail in a doc-test i think that is ok. is there a way to ignore all ApeExceptions?
There was a problem hiding this comment.
Yes currently this is failing but if my_account_alias = accounts.test_accounts[0].alias works in the testsetup then I can try and use that instead. I'll look into ignoring ApeExceptions since that would be also useful in a few other userguides.
dtdang
changed the title
|
side note: makes it a little harder to review since github does not render the markdowns as well, would be helpful to see a generated html file |
you just have to build the docs locally and look at them! we could have docs get build and deployed on PRs, maybe by special command, or maybe if it detect changes to any docs file... that is cool but a bit over-the-top imo, just build them |
punt this down the road, but would be nice to have a temporary render of each PR's docs updates to see it. can just deploy to a bucket |
| contract_json = contract_path.read_text() | ||
|
|
||
| contract = ContractType.model_validate_json(contract_json) | ||
| # project._cached_projects["MyContract"] = contract |
There was a problem hiding this comment.
is this not needed?
| # project._cached_projects["MyContract"] = contract |
There was a problem hiding this comment.
It is necessary but I'm still working on storing the contract as a cached project to be used in other examples.
There was a problem hiding this comment.
i think you an do chain.contracts[address] = contract_type.
| contract = Contract("v2.registry.ychad.eth") | ||
| >>> from ape import Contract | ||
|
|
||
| >>> contract = Contract("v2.registry.ychad.eth") |
There was a problem hiding this comment.
this will fail if ape-ens and ape-etherscan plugins are no installed, which i dont think they are in CI
There was a problem hiding this comment.
I will remove this doctest then.
| >>> # Same as doing `networks.ethereum.local.use_provider("test")`. | ||
| >>> with networks.parse_network_choice("ethereum:local:test") as provider: | ||
| ... print(provider.name) | ||
| test |
There was a problem hiding this comment.
what is this final test here? (the word)
There was a problem hiding this comment.
The final test here is the output string that the doctest is expecting to compare to the results from the test above.
|
This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days. |
|
This PR was closed because it has been inactive for 35 days. |
What I did
Add doctesting to the documentation userguides.
fixes: #657
How I did it
How to verify it
Checklist