-
Notifications
You must be signed in to change notification settings - Fork 60
Update Loadable Plug-in section #86
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
Conversation
Signed-off-by: Mahfuza <[email protected]>
Signed-off-by: Mahfuza <[email protected]>
Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR. In general, the patches focus on providing more detailed instructions for creating WasmEdge loadable plugins, adding options for the programming language to create plugins, fixing typos, and maintaining the consistency of the documentation formatting. The potential issues are relatively minor, such as grammar and formatting errors or ambiguous changes that do not provide a clear context. The most important finding is the addition of new programming language support for the WasmEdge Plugin SDK, such as Rust and C, which will increase the flexibility of creating plugins that suit developers' preferences. The reviewer should check the accuracy of the updated content against the project guidelines and standards to ensure that the changes are aligned with the project's objectives. DetailsCommit b2fa4ed624114e749eb081ba6a6626b72fd1d40aKey changes:
Potential problems:
Commit 5ba52966872d56967f5e02e4e0fac51a03390fabThe key changes in this patch are the addition of more detailed steps for using a loadable plugin and how it can be registered with the WasmEdge runtime environment. It also mentions how a WebAssembly module can import the plugin module and execute its functions. A potential problem could be if the patch does not provide enough context around the changes. It would be helpful to know why these changes were made and what problem they are trying to solve. Additionally, some developers may prefer more detailed instructions on how to use the API functions mentioned. Commit aa1955cb88a8c3c7c40780a59af9988289276b0cThe key change in this GitHub patch is that it adds Rust as an option for developers to use the WasmEdge Plugin SDK when creating a loadable plugin for WasmEdge. Additionally, it clarifies the steps involved in creating and using a loadable plugin. There are no apparent potential problems with this patch. Commit 9b96815a4274e3cfbe8b26b77432a0f881a76fd9Key changes:
Potential problems:
Commit 6e337223b2a2d6c6f2e5b017c9c3691757837ba7The patch is a minor change that removes a single whitespace character in the Loadable Plug-in documentation. There are no potential problems identified with this patch. |
@q82419 Could you please helo review this? |
@mhmohona Could you please fix the DCO check? |
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.
You lost the most important part.
A plug-in can be loaded only after loading that plug-in from file with APIs.
Refer to the steps:
https://wasmedge.org/book/en/sdk/c/ref.html#plug-ins
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.
@mhmohona Can we please make the above changes?
"Signed-off-by: mhmohona <[email protected]>"
Signed-off-by: mahfuza <[email protected]> Signed-off-by: Mahfuza <[email protected]>
Signed-off-by: Mahfuza <[email protected]>
Hello @q82419, thank you for your kind feedback. Regarding updating the section I have one confusion - shall I add these steps in the documents for plugin guideline? |
You should add these steps. |
Please fix the DCO test and then we can merge this PR. Thanks. |
Reopened another PR to pass DOC test - #106 |
Explanation
Update Loadable Plug-in section - expanded explanation and added flowchart for better understanding of the workflow.
Related issue:
What type of PR is this
/kind documentation
Proposed Changes