From 3556ffde5d4b2b6e9e2ba26c9d8d0679288b42a0 Mon Sep 17 00:00:00 2001
From: James Ray <16969914+jamesray1@users.noreply.github.com>
Date: Wed, 28 Nov 2018 10:13:00 +0000
Subject: [PATCH] Fix a typo and grammar and add a clarification. (#688)

* Fix a typo and grammar and add a clarification.

* Update core/src/nodes/handled_node_tasks.rs

Co-Authored-By: jamesray1 <16969914+jamesray1@users.noreply.github.com>
---
 core/src/nodes/handled_node_tasks.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/core/src/nodes/handled_node_tasks.rs b/core/src/nodes/handled_node_tasks.rs
index 7be5d505..c8cbea6b 100644
--- a/core/src/nodes/handled_node_tasks.rs
+++ b/core/src/nodes/handled_node_tasks.rs
@@ -58,7 +58,7 @@ use void::Void;
 
 /// Implementation of `Stream` that handles a collection of nodes.
 pub struct HandledNodesTasks<TInEvent, TOutEvent, THandler> {
-    /// For each active task, a sender allowing to transmit messages. Closing the sender interrupts
+    /// A map between active tasks to an unbounded sender, used to control the task. Closing the sender interrupts
     /// the task. It is possible that we receive messages from tasks that used to be in this list
     /// but no longer are, in which case we should ignore them.
     tasks: FnvHashMap<TaskId, mpsc::UnboundedSender<TInEvent>>,
@@ -101,7 +101,7 @@ pub enum HandledNodesEvent<TOutEvent, THandler> {
         handler: Option<THandler>,
     },
 
-    /// A task has succeesfully connected to a node.
+    /// A task has successfully connected to a node.
     NodeReached {
         /// Identifier of the task that succeeded.
         id: TaskId,
@@ -202,7 +202,7 @@ impl<TInEvent, TOutEvent, THandler> HandledNodesTasks<TInEvent, TOutEvent, THand
         self.tasks.keys().cloned()
     }
 
-    /// Provides an API similar to `Stream`, except that it cannot error.
+    /// Provides an API similar to `Stream`, except that it cannot produce an error.
     pub fn poll(&mut self) -> Async<HandledNodesEvent<TOutEvent, THandler>> {
         for to_spawn in self.to_spawn.drain() {
             tokio_executor::spawn(to_spawn);