-
Notifications
You must be signed in to change notification settings - Fork 5.4k
sway-book: fix forc call examples #7133
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sdankel
previously approved these changes
Apr 30, 2025
kayagokalp
previously approved these changes
Apr 30, 2025
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.
The current change looks good to me but we want to fix #7138 sooner or later so that the invalid title and random formatting stuff (forc-call docs being italic) does not happen.
IGI-111
approved these changes
May 1, 2025
JoshuaBatty
approved these changes
May 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
forc-call
Everything related to the `forc-call` plugin in `forc-client` package
good first issue
Good for newcomers
The Sway Book
Everything to do with the Sway Book
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request introduces updates to the documentation and examples for the
forc call
command, improving clarity, organization, and usability.The most significant changes include restructuring the documentation into a new file, updating the book summary to reflect this change, and enhancing the examples in the codebase for better readability.
Added dedicated section for
forc-call
under testing heading.Documentation Updates:
forc call
: The detailed documentation for theforc call
command has been moved to a new file,docs/book/src/forc/plugins/forc_client/forc_call_docs.md
. This includes comprehensive usage examples, parameter encoding details, and troubleshooting tips.forc_call.md
file has been removed, as its content has been migrated to the new structured format.Book Summary Update:
SUMMARY.md
: The book summary has been updated to include a link to the newforc call
documentation under the "Testing" section for better navigation.Code Example Enhancements:
call.rs
: Examples in theforc call
command's code file (forc-plugins/forc-client/src/cmd/call.rs
) have been reformatted for clarity. Each example now uses markdown-style code blocks and descriptive headings, making them easier to follow.Checklist
Breaking*
orNew Feature
labels where relevant.