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: improvement on wasm_bindgen::convert::traits #3849

Open
alivarastepour opened this issue Feb 20, 2024 · 1 comment · May be fixed by #3855
Open

docs: improvement on wasm_bindgen::convert::traits #3849

alivarastepour opened this issue Feb 20, 2024 · 1 comment · May be fixed by #3855
Labels
docs Issues related to documentation

Comments

@alivarastepour
Copy link

Hi,
I was reading the docs for Abi type in FromWasmAbi and IntoWasmAbi traits, and I thought maybe there is room for improvement in their description, e.g., the docs for Abi in FromWasmAbi says:

    /// The wasm ABI type that this converts from when coming back out from the
    /// ABI boundary.

IMO, the above description is a little puzzling. Maybe it could be rewritten to something like this:

    /// The type which wasm ABI provides when comming back from ABI boundary, to be converted to a rust type.

and similarly for IntoWasmAbi,

    /// The type which wasm ABI is provided when crossing the ABI boundary.

This could surely benefit from insights of other users.

@daxpedda daxpedda added the docs Issues related to documentation label Feb 22, 2024
@daxpedda
Copy link
Collaborator

Improvements to the docs are always welcome.
I'm happy to review a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants