Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvement #39

Open
kerrywei opened this issue Nov 19, 2021 · 0 comments
Open

Documentation improvement #39

kerrywei opened this issue Nov 19, 2021 · 0 comments
Assignees

Comments

@kerrywei
Copy link

Issue To Be Solved

There are few things that are missing/incorrect in correct API doc. i.e.
https://github.com/onflow/flow-cadut/blob/main/docs/api.md#extractsignerscode -- this method is intended to be used on transactions, however the example provided supplies a script to the function and will always result in empty array returned

The SignerPair link https://github.com/onflow/flow-cadut/blob/main/docs/api.md#SignerPair is not pointing to any section (missing content)

extractContractParameters() is not documented

Suggestion

Perform a full audit on all documents (as the issues listed here is non-exhaustive) before promoting this tool to a wider audience

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants