wasmtime icon indicating copy to clipboard operation
wasmtime copied to clipboard

Simple terminology for unfamiliar readers

Open rich-murphey opened this issue 4 years ago • 5 comments

As the first introduction it may be helpful for certain readers, to define the abbreviations, and use familiar concrete terms. Consider a reader who is unfamiliar with WASM and is just beginning to study it, and is asking the question, when would l need this? I feel, adding concrete terms, provides more immediate answers to that kind of question.

rich-murphey avatar Jun 06 '20 07:06 rich-murphey

I restored the links, and and changed WASM to Wasm. I also used "Wasi" to be consistent.

My first reading of the intro also begged questions such as: What is Wasm. What are it's limitations? (and given those:) What is Wasm-bindgen? What does WASI add?

So, i added a transition paragraph that touches on them and tries to tie them together for the next paragraph about Wasmtime.

Again simple terms are used, to try to make it easier for the reader. This understates the significance of the components.

rich-murphey avatar Jun 06 '20 23:06 rich-murphey

"Wasm" is an abbreviation, while "WASI" is an acronym, and they really are written with different styles in practice today.

Is that too confusing? It's probably still possible to change "WASI" to "Wasi" at this point, if people feel strongly about it and there are no objections from the Subgroup.

sunfishcode avatar Jun 08 '20 22:06 sunfishcode

WASI should be OK since it's following a consistent convention. If a definition is there, it shouldn't create confusion.

BTW, I'm not expecting you'll necessarily use any proposed words as is, and you all are welcome to excerpt or change anything I suggest as needed. I'm a somewhat recent convert to rust, and I what I hope to suggest are clarity for new users who are bootstrapping themselves, from less background, which is where I am coming from. It's challenging to write for two very different groups: new users and internals developers, not just for the desire for technical clarity, but conventions. So this is understandable.

rich-murphey avatar Jun 09 '20 01:06 rich-murphey

I've tried to clarify that high-level languages must be compiled to Wasm prior to loading using Wasmtime. Here's some recent discussion where confusion about this arose on reddit.

Embeddable Lua-like scripting for both native and browser (Wasm)?

rich-murphey avatar Jun 15 '20 00:06 rich-murphey

"Wasm" is an abbreviation, while "WASI" is an acronym, and they really are written with different styles in practice today.

Is that too confusing? It's probably still possible to change "WASI" to "Wasi" at this point, if people feel strongly about it and there are no objections from the Subgroup.

FWIW, I believe it should always stay as "WASI" since as you guys pointed out, it's an acronym after all.

kubkon avatar Jul 10 '20 06:07 kubkon

I'm going through some old PRs and I see that this one has languished for quite awhile. I'm going to close this as quite a lot has changed in the meantime, but PRs are of course always welcome for improvements!

alexcrichton avatar Mar 01 '24 19:03 alexcrichton