-
Notifications
You must be signed in to change notification settings - Fork 19
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
sc-platform/iota-transactional-test-runner documentation #5335
Conversation
…ax (#4699) * feat: document run graphql syntax * feat: Describe interpolation rules * feat: Use a better representing example * refactor: Add description to the provided example * refactor: Better describe syntax rule for --cursors * refactor: Expand on cursor syntax * refactor: Expand on cursor syntax * refactor: Add object cursor example * refactor: Remove part of file path * refactor: Clarify x for FakeId (x, y) * refactor: Fix typo
… print-bytecode task commands (#5128) * feat(iota-tx-test-runner/docs): documentation of init, run, publish, print-bytecode task commands
* doc(iota-tx-test-runner): documenting of test runner subcommands
* doc(test_runner): run_test flow execution
* doc(test-runner): add explanation about fake object indexing
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great article :), just some comments around punction and casing for the most part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, this flourished! Kudos on the thorough work!
I think it looks great. The only (optional) suggestion I have is to add something like a table-of-contents on the top to allow some navigation in the page. Covering up to ###
sections would do I guess.
Description of change
Documentation of
init
,run
,publish
,print-bytecode
task commands in order to have good usage perspectiveDocumentation of test runner subcommands.
Documentation for the
run_test
function, which executes Move code and compares the output to the corresponding .exp fileImplement the section Common rules that documents how object ids work.
Links to any relevant issues
Closes #1979
Fixes #5122.
Fixes #5123.
Fixes #5125.
Fix #5200 .
Type of change