You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When explaining the different files provided as part of the wasm-pack-template, the tutorial mentions:
The src/utils.rs module provides a couple included batteries that we will use later in the tutorial. We can ignore it for now.
Why does it not make sense?
The set phrase I'm used to seeing is specifically "batteries included", in that order. However, if you don't know what it means for software to have "batteries included" (particularly if you come from a background or part of the industry where this phrase is not one you have been exposed to), this explanation isn't very helpful.
Also, for myself personally, I am a big-picture learner, so this explanation doesn't advance my understanding of the purpose of mod utils or why it's included. In particular, "[...] we will use [this] later in the tutorial." isn't very helpful to me because it doesn't give me an indication of when in the tutorial I might be interested in mod utils or required to use it as part of a tutorial activity.
How could we improve it?
We could explain the use of mod utils in plain English:
The src/ustils.rs module provides common utilities to make working with Rust compiled to WebAssembly easier. We will take a look at some of these utilities in more detail later in the tutorial, so we can ignore this file for now.
I would ideally also like to see a mention of specifically when in the tutorial we will use mod utils. To slightly rephrase the above and include this indication:
The src/ustils.rs module provides common utilities to make working with Rust compiled to WebAssembly easier. We will take a look at some of these utilities in more detail later in the tutorial, such as when we look at debugging our wasm code, but we can ignore this file for now.
I'd love to get some feedback on this rephrasing, and would be very happy to contribute a PR if this new phrasing is acceptable.
The text was updated successfully, but these errors were encountered:
Where in the docs did you come across this?
Section 5.2 Hello, world!
Describe what about it does not make sense
When explaining the different files provided as part of the
wasm-pack-template
, the tutorial mentions:Why does it not make sense?
The set phrase I'm used to seeing is specifically "batteries included", in that order. However, if you don't know what it means for software to have "batteries included" (particularly if you come from a background or part of the industry where this phrase is not one you have been exposed to), this explanation isn't very helpful.
Also, for myself personally, I am a big-picture learner, so this explanation doesn't advance my understanding of the purpose of
mod utils
or why it's included. In particular, "[...] we will use [this] later in the tutorial." isn't very helpful to me because it doesn't give me an indication of when in the tutorial I might be interested inmod utils
or required to use it as part of a tutorial activity.How could we improve it?
We could explain the use of
mod utils
in plain English:I would ideally also like to see a mention of specifically when in the tutorial we will use
mod utils
. To slightly rephrase the above and include this indication:I'd love to get some feedback on this rephrasing, and would be very happy to contribute a PR if this new phrasing is acceptable.
The text was updated successfully, but these errors were encountered: