PR feedback on adder commentary

Author: mkatychev

component-model/examples/tutorial/adder/src/bindings.rs

@@ -1,12 +1,12 @@
-// Generated by `wit-bindgen` 0.36.0. DO NOT EDIT!
+// Generated by `wit-bindgen` 0.41.0. DO NOT EDIT!
 // Options used:
 //   * runtime_path: "wit_bindgen_rt"
 #[rustfmt::skip]
 #[allow(dead_code, clippy::all)]
 pub mod exports {
     pub mod docs {
         pub mod adder {
-            #[allow(dead_code, clippy::all)]
+            #[allow(dead_code, async_fn_in_trait, unused_imports, clippy::all)]
             pub mod add {
                 #[used]
                 #[doc(hidden)]
@@ -25,9 +25,10 @@ pub mod exports {
                 #[doc(hidden)]
                 macro_rules! __export_docs_adder_add_0_1_0_cabi {
                     ($ty:ident with_types_in $($path_to_types:tt)*) => {
-                        const _ : () = { #[export_name = "docs:adder/[email protected]#add"]
-                        unsafe extern "C" fn export_add(arg0 : i32, arg1 : i32,) -> i32 {
-                        $($path_to_types)*:: _export_add_cabi::<$ty > (arg0, arg1) } };
+                        const _ : () = { #[unsafe (export_name =
+                        "docs:adder/[email protected]#add")] unsafe extern "C" fn export_add(arg0
+                        : i32, arg1 : i32,) -> i32 { unsafe { $($path_to_types)*::
+                        _export_add_cabi::<$ty > (arg0, arg1) } } };
                     };
                 }
                 #[doc(hidden)]
@@ -38,6 +39,7 @@ pub mod exports {
 }
 #[rustfmt::skip]
 mod _rt {
+    #![allow(dead_code, clippy::all)]
     #[cfg(target_arch = "wasm32")]
     pub fn run_ctors_once() {
         wit_bindgen_rt::run_ctors_once();
@@ -102,8 +104,8 @@ mod _rt {
         }
     }
 }
-/// Generates `#[no_mangle]` functions to export the specified type as the
-/// root implementation of all generated traits.
+/// Generates `#[unsafe(no_mangle)]` functions to export the specified type as
+/// the root implementation of all generated traits.
 ///
 /// For more information see the documentation of `wit_bindgen::generate!`.
 ///
@@ -133,14 +135,17 @@ macro_rules! __export_adder_impl {
 #[doc(inline)]
 pub(crate) use __export_adder_impl as export;
 #[cfg(target_arch = "wasm32")]
-#[link_section = "component-type:wit-bindgen:0.36.0:docs:[email protected]:adder:encoded world"]
+#[unsafe(
+    link_section = "component-type:wit-bindgen:0.41.0:docs:[email protected]:adder:encoded world"
+)]
 #[doc(hidden)]
+#[allow(clippy::octal_escapes)]
 pub static __WIT_BINDGEN_COMPONENT_TYPE: [u8; 203] = *b"\
 \0asm\x0d\0\x01\0\0\x19\x16wit-component-encoding\x04\0\x07P\x01A\x02\x01A\x02\x01\
-B\x02\x01@\x02\x01ay\x01by\0y\x04\0\x03add\x01\0\x04\0\x14docs:adder/[email protected]\x05\
+B\x02\x01@\x02\x01xy\x01yy\0y\x04\0\x03add\x01\0\x04\0\x14docs:adder/[email protected]\x05\
 \0\x04\0\x16docs:adder/[email protected]\x04\0\x0b\x0b\x01\0\x05adder\x03\0\0\0G\x09pr\
-oducers\x01\x0cprocessed-by\x02\x0dwit-component\x070.220.0\x10wit-bindgen-rust\x06\
-0.36.0";
+oducers\x01\x0cprocessed-by\x02\x0dwit-component\x070.227.1\x10wit-bindgen-rust\x06\
+0.41.0";
 #[inline(never)]
 #[doc(hidden)]
 pub fn __link_custom_section_describing_imports() {

component-model/examples/tutorial/adder/src/lib.rs

@@ -1,8 +1,13 @@
 #[allow(warnings)]
 mod bindings;
 
-// Separating out the interface puts it in a sub-module
+// The comments that follow the use declaration below correlate the rust module path with their
+// `world.wit` counterparts:
 use bindings::exports::docs::adder::add::Guest;
+//            <- items bundled with `export` keyword
+//                     <- package namespace
+//                           <- package field
+//                                  <- interface name
 
 struct Component;
 

component-model/src/language-support/rust.md

@@ -89,10 +89,7 @@ Now, let's build our component, being sure to optimize with a release build:
 cargo component build --release
 ```
 
-You can use `wasm-tools` to inspect the WIT package generated by `cargo-component`:
-
-
-You can use `wasm-tools component wit` to output the WIT package of the component:
+You can use `wasm-tools` to output the WIT package of the component:
 
 ```console
 wasm-tools component wit target/wasm32-wasip1/release/add.wasm
@@ -118,7 +115,7 @@ package docs:[email protected] {
 ### Running a Component
 
 To verify that our component works, lets run it from a Rust application that knows how to run a
-component targeting the [`docs:adder/adder`](#adding-the-wit-world) world.
+component targeting the [`adder` world](#adding-the-wit-world).
 
 The application uses [`wasmtime`](https://github.com/bytecodealliance/wasmtime) crates to generate
 Rust bindings, bring in WASI worlds, and execute the component.