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

docs: add instructions for derive macro dynamic implementation #70

Merged
merged 3 commits into from May 13, 2024

Conversation

Placebo27
Copy link
Contributor

@Placebo27 Placebo27 commented May 12, 2024

In PR #67 , #68 and #69 , the #[rustsbi(dynamic)] macro implementation can dynamically adapt extensions.
However, this section is not in the current documentation, which has been updated for completeness and to make it easier for readers to learn about the latest dynamic features. Now we can see the usage of the section and an example description in the documentation are as follow:
Usage
image
Example
image

This pull request add usage and an example for dynamic implementations to the Derive Macro documentation.

Contributors to this pull request: special thanks to @Plucky923 for contributions on this pull request.

Signed-off-by: Zhenchen Wang <m202372036@hust.edu.cn>
@Placebo27 Placebo27 force-pushed the placebo27/docs branch 5 times, most recently from 065e0f5 to 1feb9bf Compare May 12, 2024 13:57
Signed-off-by: DongQing <placebo27@hust.edu.cn>
docs: add documents for #[rustsbi(dynamic)].
Copy link
Member

@duskmoon314 duskmoon314 left a comment

Choose a reason for hiding this comment

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

LGTM. I wonder whether doc is more appropriate than lib in the commit message. @luojia65

@Placebo27 Placebo27 changed the title lib: add instructions for derive macro dynamic implementation docs: add instructions for derive macro dynamic implementation May 13, 2024
Copy link
Member

@luojia65 luojia65 left a comment

Choose a reason for hiding this comment

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

Nice catch, LGTM. Following the Conventional Commits specification, the modified title is properly prefixed with docs.

@luojia65 luojia65 merged commit 32a8452 into rustsbi:main May 13, 2024
10 checks passed
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.

None yet

5 participants