Add devdocs to generated contract wrappers #2013
Conversation
|
xianny
requested review from
fabioberger
and removed request for
hysz and
abandeali1
There was a problem hiding this comment.
Can we also enable doc generation (via package.json) for abi-gen/test-cli? (Note that I requested some changes around your abi-gen-wrappers/package.json; whatever we end up doing there we should also do similarly for test-cli in abi-gen/package.json.)
Can you persist the generated documentation (both for abi-gen-wrappers and abi-gen/test-cli) as CircleCI Build Artifacts? (See store_artifacts tasks in .circleci/config.yml for an example.) That way I don't have to check out and build your branch just to review the doc. 😛
packages/abi-gen-wrappers/src/generated-wrappers/asset_proxy_owner.ts
Outdated
Show resolved
Hide resolved
packages/abi-gen-wrappers/src/generated-wrappers/asset_proxy_owner.ts
Outdated
Show resolved
Hide resolved
xianny
force-pushed
the
multilang-1903/devdocs
branch
from
9d945f6 to
ab72e29
Compare
.circleci/config.yml
Outdated
| @@ -234,6 +234,8 @@ jobs: | |||
| key: coverage-python-sra-client-{{ .Environment.CIRCLE_SHA1 }} | |||
| paths: | |||
| - ~/repo/python-packages/sra_client/.coverage | |||
| - store_artifacts: | |||
| path: ~/repo/packages/abi-gen-wrappers/generated_docs | |||
There was a problem hiding this comment.
This is in the wrong spot. You've got it persisting artifacts generated as part of test-python, but the docs are generated over in build, not test-python. This addition needs to move over to be part of build. (Concretely, I don't see any abi-gen-wrappers artifacts available in the test-python build results.)
| * sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used | ||
| * to create a 0x transaction (see protocol spec for more details). | ||
| * @param _secondsTimeLocked Duration needed after a transaction is confirmed | ||
| * and before it becomes executable, in seconds. |
There was a problem hiding this comment.
My aesthetic eye would like to see wrapped lines (here "and before...") indented 4 spaces, aka a hanging indent. But if this is convention, and, more importantly, if the generated docs look fine, then whatever.
|
Updated. Build artifacts visible here: https://82906-92181371-gh.circle-artifacts.com/0/home/circleci/repo/packages/abi-gen-wrappers/generated_docs/index.html Right now the goal is to just check that they are valid typedoc i.e. will be generated to readable markdown/html. Will use #2033 when it's ready. |
Description
Adds devdocs to generated contract-wrappers from Solidity doc comments. Resolves #1903
TODO
callAsync,estimateGasAsync- [ ] put generated docs in publish workflow or try new docs workflowON HOLDTesting instructions
Run
yarn docsand look at generated docsindex.html!Types of changes
Checklist:
[WIP]if necessary.