fix doc comments

Signed-off-by: Michael X. Grey <greyxmike@gmail.com>

Author: mxgrey

src/buffer/json_buffer.rs

@@ -146,8 +146,6 @@ pub struct JsonBufferKey {
 
 impl JsonBufferKey {
     /// Downcast this into a concrete [`BufferKey`] for the specified message type.
-    ///
-    /// To downcast into a specialized kind of buffer key, use [`Self::downcast_buffer_key`] instead.
     pub fn downcast_for_message<T: 'static>(&self) -> Option<BufferKey<T>> {
         if TypeId::of::<T>() == self.interface.any_access_interface().message_type_id() {
             Some(BufferKey {
@@ -420,7 +418,7 @@ impl<'w, 's, 'a> JsonBufferMut<'w, 's, 'a> {
         self.storage.json_push_as_oldest(self.session, message)
     }
 
-    /// Same as [`Self:push_as_oldest`] but no serialization step is needed for
+    /// Same as [`Self::push_as_oldest`] but no serialization step is needed for
     /// the incoming message.
     pub fn push_json_as_oldest(
         &mut self,

src/diagram.rs

@@ -375,37 +375,7 @@ pub struct Diagram {
 }
 
 impl Diagram {
-    /// Spawns a workflow from this diagram.
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use bevy_impulse::{Diagram, DiagramError, NodeBuilderOptions, DiagramElementRegistry, RunCommandsOnWorldExt};
-    ///
-    /// let mut app = bevy_app::App::new();
-    /// let mut registry = DiagramElementRegistry::new();
-    /// registry.register_node_builder(NodeBuilderOptions::new("echo".to_string()), |builder, _config: ()| {
-    ///     builder.create_map_block(|msg: String| msg)
-    /// });
-    ///
-    /// let json_str = r#"
-    /// {
-    ///     "version": "0.1.0",
-    ///     "start": "echo",
-    ///     "ops": {
-    ///         "echo": {
-    ///             "type": "node",
-    ///             "builder": "echo",
-    ///             "next": { "builtin": "terminate" }
-    ///         }
-    ///     }
-    /// }
-    /// "#;
-    ///
-    /// let diagram = Diagram::from_json_str(json_str)?;
-    /// let workflow = app.world.command(|cmds| diagram.spawn_io_workflow(cmds, &registry))?;
-    /// # Ok::<_, DiagramError>(())
-    /// ```
+    /// Implementation for [Self::spawn_io_workflow].
     // TODO(koonpeng): Support streams other than `()` #43.
     /* pub */
     fn spawn_workflow<Streams>(
@@ -447,7 +417,37 @@ impl Diagram {
         Ok(w)
     }
 
-    /// Wrapper to [spawn_workflow::<()>](Self::spawn_workflow).
+    /// Spawns a workflow from this diagram.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use bevy_impulse::{Diagram, DiagramError, NodeBuilderOptions, DiagramElementRegistry, RunCommandsOnWorldExt};
+    ///
+    /// let mut app = bevy_app::App::new();
+    /// let mut registry = DiagramElementRegistry::new();
+    /// registry.register_node_builder(NodeBuilderOptions::new("echo".to_string()), |builder, _config: ()| {
+    ///     builder.create_map_block(|msg: String| msg)
+    /// });
+    ///
+    /// let json_str = r#"
+    /// {
+    ///     "version": "0.1.0",
+    ///     "start": "echo",
+    ///     "ops": {
+    ///         "echo": {
+    ///             "type": "node",
+    ///             "builder": "echo",
+    ///             "next": { "builtin": "terminate" }
+    ///         }
+    ///     }
+    /// }
+    /// "#;
+    ///
+    /// let diagram = Diagram::from_json_str(json_str)?;
+    /// let workflow = app.world.command(|cmds| diagram.spawn_io_workflow(cmds, &registry))?;
+    /// # Ok::<_, DiagramError>(())
+    /// ```
     pub fn spawn_io_workflow(
         &self,
         cmds: &mut Commands,

src/diagram/registration.rs

@@ -985,7 +985,7 @@ impl DiagramElementRegistry {
     /// Register a node builder with all the common operations (deserialize the
     /// request, serialize the response, and clone the response) enabled.
     ///
-    /// You will receive a [`RegistrationBuilder`] which you can then use to
+    /// You will receive a [`NodeRegistrationBuilder`] which you can then use to
     /// enable more operations around your node, such as fork result, split,
     /// or unzip. The data types of your node need to be suitable for those
     /// operations or else the compiler will not allow you to enable them.