Explanation of `mod utils` is unclear #127
Closed
Comments
This rephrasing sounds great to me! Would merge a PR that did that rephrasing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: