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

sc-platform/iota-transactional-test-runner documentation #5335

Merged
merged 10 commits into from
Feb 21, 2025

Conversation

Dkwcs
Copy link
Contributor

@Dkwcs Dkwcs commented Feb 11, 2025

Description of change

Documentation of init, run, publish, print-bytecode task commands in order to have good usage perspective
Documentation of test runner subcommands.
Documentation for the run_test function, which executes Move code and compares the output to the corresponding .exp file
Implement 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

  • Documentation Fix

kodemartin and others added 6 commits September 16, 2024 13:17
…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
@Dkwcs Dkwcs added the documentation Improvements or additions to documentation label Feb 11, 2025
@Dkwcs Dkwcs self-assigned this Feb 11, 2025
@Dkwcs Dkwcs requested a review from a team as a code owner February 11, 2025 14:20
Copy link

vercel bot commented Feb 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
apps-backend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 21, 2025 8:24am
apps-ui-kit ✅ Ready (Inspect) Visit Preview Feb 21, 2025 8:24am
rebased-explorer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 21, 2025 8:24am
wallet-dashboard ✅ Ready (Inspect) Visit Preview Feb 21, 2025 8:24am

@iota-ci iota-ci added sc-platform Issues related to the Smart Contract Platform group. vm-language Issues related to the VM & Language Team labels Feb 11, 2025
@Dkwcs Dkwcs changed the title Sc platform/transactional tests syntax sc-platform/iota-transactional-test-runner documentation Feb 11, 2025
Copy link
Contributor

@lucas-tortora lucas-tortora left a 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.

Copy link
Contributor

@kodemartin kodemartin left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation sc-platform Issues related to the Smart Contract Platform group. vm-language Issues related to the VM & Language Team
Projects
None yet
6 participants