Skip to content

[MOV-113] Add move to code blocks #22853

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

akmysti
Copy link

@akmysti akmysti commented Jul 23, 2025

Description

Documentation

Test plan

doctest


Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • gRPC:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK: None

@akmysti akmysti requested a review from ronny-mysten as a code owner July 23, 2025 17:01
@akmysti akmysti temporarily deployed to sui-typescript-aws-kms-test-env July 23, 2025 17:01 — with GitHub Actions Inactive
Copy link

vercel bot commented Jul 23, 2025

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

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 29, 2025 2:08pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Jul 29, 2025 2:08pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Jul 29, 2025 2:08pm

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is going to annotate every code block with move regardless of whether it is move code or not (the code block in the token.move docs is evidence of this). It seems like the right thing to do is to update the .move source code to include move on code blocks in doc comments.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this docgen runs only on move files, no?

@akmysti akmysti temporarily deployed to sui-typescript-aws-kms-test-env July 29, 2025 04:50 — with GitHub Actions Inactive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is incorrect. The code block in question does not contain Move code.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i see. this is a tricky one as it is coming from the 'sui-framework/packages/sui-framework/sources/kiosk/kiosk.move' file. Not sure how to handle this.

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

Successfully merging this pull request may close these issues.

3 participants