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

Update develop_plugin_c.md #216

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

peter-jerry-ye
Copy link

Explanation

Make the code example for developing plugins in C complete. Now one can copy all the code snippets and expect it to work.

Related issue

Closes WasmEdge/WasmEdge#3122

What type of PR is this

/kind documentation

Proposed Changes

Copied the missing part of testplugin.c into the document

Copy link
Collaborator

alabulei1 commented Feb 24, 2024

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Commit 4ee30642d3777492adc54ff3ad6da88131187bfc

Key Changes:

  • Added a new function WasmEdge_Plugin_GetDescriptor to export the plug-in descriptor.

Potential Problems:

  1. The newly added function WasmEdge_Plugin_GetDescriptor does not have any input parameters or return type specified. It's unclear if this aligns with the existing coding standards and conventions, as normally functions have explicit input parameters and return types defined.
  2. There is no description provided for the function WasmEdge_Plugin_GetDescriptor, which may make it difficult for other developers to understand its purpose and proper usage.
  3. The patch does not include any test cases or updates to the existing tests for the changes made in the code. It's important to ensure that new functionality is properly tested to maintain code quality.
  4. It would be beneficial to include comments explaining the purpose of exporting the plug-in descriptor and how it fits into the overall functionality of the plugin. This adds clarity for future developers who may work on this codebase.

@alabulei1
Copy link
Collaborator

Hi @peter-jerry-ye

Thanks for the PR. Could you please fix the DCO issues? Thanks.

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.

Plugin built from C11 is shown in the plugin list.
2 participants