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

Deduplicate oak_abi documentation #812

Closed
tiziano88 opened this issue Apr 2, 2020 · 1 comment
Closed

Deduplicate oak_abi documentation #812

tiziano88 opened this issue Apr 2, 2020 · 1 comment
Assignees

Comments

@tiziano88
Copy link
Collaborator

Currently the following two files both describe the Wasm ABI host functions, but with slightly different wordings and parameter names

This does not seem to add much value, and in fact it's easy for them to get out of sync over time, or end up with slightly inconsistent descriptions. We should pick one of them as the source of truth, and just add links to it from the other one.

For language-specific details (e.g. Rust types) we can of course have a more detailed documentation in addition to the link, but it should not try to replicate the contents of the master documentation.

@daviddrysdale WDYT?

@daviddrysdale
Copy link
Contributor

Closing in favour of #877

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

No branches or pull requests

2 participants