Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Document entity types better #1038

Closed
jyn514 opened this issue Sep 17, 2019 · 1 comment
Closed

Document entity types better #1038

jyn514 opened this issue Sep 17, 2019 · 1 comment

Comments

@jyn514
Copy link
Contributor

jyn514 commented Sep 17, 2019

Consider a frontend that wants to emit a call instruction. The documentation states that you need to pass

However, neither of the documentations for those types show how you can get an instance of them! For Value you can look around on the rest of the page for InstBuilder and see that most instructions return a Value, but for FuncRef it's non-obvious that you need to either call import_function or declare_func_in_func. It would be great to link to these pages in the documentation for FuncRef.

Similar problems exist for

jyn514 added a commit to jyn514/cranelift that referenced this issue Sep 17, 2019
@jyn514
Copy link
Contributor Author

jyn514 commented Sep 17, 2019

Does anyone know how to make a link to a dependent crate? I want to link to cranelift_module::Module in a cranelift_codegen file.

jyn514 added a commit to jyn514/cranelift that referenced this issue Sep 17, 2019
Addresses bytecodealliance#1038

Document stackslots, funcrefs, heaps, sigrefs, and jumptables
@abrown abrown closed this as completed in d46311c Sep 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant