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
Currently the Rust example often uses the same name for packages, functions, worlds, interfaces. (This might also be the case elsewhere in the book, not sure)
Here the package name is the same as the world name and the interface name is the same as the function name. Once you start using it elsewhere in the example it can be very unclear if you refer to the package, world, interface,... While this works fine for someone who is just copy pasting the example, true understanding requires one to know where to reference what exactly. This example is very hard to extrapolate to other components and projects.
I would propose that the examples clearly label everything e.g., adder-package, adder-world,...
If other people agree I could create a pull-request for this.
The text was updated successfully, but these errors were encountered:
Currently the Rust example often uses the same name for packages, functions, worlds, interfaces. (This might also be the case elsewhere in the book, not sure)
Example:
component-docs/component-model/src/language-support/rust.md
Lines 82 to 92 in 31445f3
Here the package name is the same as the world name and the interface name is the same as the function name. Once you start using it elsewhere in the example it can be very unclear if you refer to the package, world, interface,... While this works fine for someone who is just copy pasting the example, true understanding requires one to know where to reference what exactly. This example is very hard to extrapolate to other components and projects.
I would propose that the examples clearly label everything e.g.,
adder-package
,adder-world
,...If other people agree I could create a pull-request for this.
The text was updated successfully, but these errors were encountered: