Merge pull request #5 from acehreli/master

Several typo fixes and other minor changes

Author: dcarp

README.md

@@ -1,6 +1,6 @@
 [![Build Status](https://travis-ci.org/dcarp/asynchronous.png?branch=master)](https://travis-ci.org/dcarp/asynchronous)
 
-#`asynchonous`#
+#`asynchronous`#
 This library provides infrastructure for writing concurrent code using coroutines, multiplexing I/O access over sockets and other resources, running network clients and servers, and other related primitives.
 
 *It implements most of the python 3 [asyncio API](https://docs.python.org/3/library/asyncio.html).*
@@ -17,7 +17,7 @@ Can be found at: http://dcarp.github.io/asynchronous/index.html
 * Locks and semaphores (done)
 * Queues (done)
 
-####Why yet another async library? What wrong with vibe.d?####
+####Why yet another async library? What is wrong with vibe.d?####
 * `asynchronous` is a library and not a framework
 * it is not web-oriented, compatible with `std.socket`
 * arguably nicer API

dub.json

@@ -1,6 +1,6 @@
 {
     "name": "asynchronous",
-    "description": "Asynchonous library for D",
+    "description": "Asynchronous library for D",
     "license": "Boost 1.0",
     "copyright": "Copyright © 2015-2016 Dragoş Carp",
     "authors": [

src/asynchronous/events.d

@@ -28,7 +28,7 @@ alias Protocol = asynchronous.protocols.Protocol;
 interface CallbackHandle
 {
     /**
-     * Cancel the call. If the callback is already canceled or executed, this
+     * Cancel the call. If the callback is already cancelled or executed, this
      * method has no effect.
      */
     void cancel();
@@ -76,7 +76,7 @@ if (isDelegate!Dg)
     }
 
     /**
-     * Cancel the call. If the callback is already canceled or executed, this
+     * Cancel the call. If the callback is already cancelled or executed, this
      * method has no effect.
      */
     override void cancel()
@@ -334,7 +334,7 @@ abstract class EventLoop
      *
      * Every callback scheduled before $(D_PSYMBOL stop()) is called will run.
      * Callbacks scheduled after $(D_PSYMBOL stop()) is called will not run.
-     * Howerver, those callbacks will run if $(D_PSYMBOL runForever()) is
+     * However, those callbacks will run if $(D_PSYMBOL runForever()) is
      * called again later.
      */
     final void stop()
@@ -538,7 +538,7 @@ abstract class EventLoop
      *      overrides the hostname that the target server’s certificate will be
      *      matched against. By default the value of the host argument is used.
      *      If host is empty, there is no default and you must pass a value for
-     *      $(D_PSYMBOL serverHostname). If $(D_PSYMBOL serverHostname) is an
+     *      $(D_PSYMBOL serverHostname). If $(D_PSYMBOL serverHostname) is
      *      empty, hostname matching is disabled (which is a serious security
      *      risk, allowing for man-in-the-middle-attacks).
      *
@@ -556,7 +556,7 @@ abstract class EventLoop
      *      be specified.
      *
      *  localHost = if given, together with $(D_PSYMBOL localService) is used to
-     *      bind the socket to locally. The $(D_PSYMBOL localHost) and
+     *      bind the socket locally. The $(D_PSYMBOL localHost) and
      *      $(D_PSYMBOL localService) are looked up using $(D_PSYMBOL
      *      getAddressInfo()), similarly to host and service.
      *
@@ -727,7 +727,7 @@ abstract class EventLoop
         else
         {
             enforce(remoteHost.empty,
-                "Remote host parameter not supportored yet");
+                "Remote host parameter not supported yet");
 
             auto addressInfos = getAddressInfo(localHost, localService,
                 addressFamily, SocketType.DGRAM, protocolType,
@@ -846,7 +846,7 @@ abstract class EventLoop
         }
         else
         {
-            enforce(socket !is null, "no path and sock were specified");
+            enforce(socket !is null, "no path and socket were specified");
             enforce(socket.addressFamily == AddressFamily.UNIX,
                 "A UNIX Domain Socket was expected, got %s".format(socket));
             socket.blocking(false);
@@ -865,7 +865,7 @@ abstract class EventLoop
     //path is a str, representing a file systsem path to bind the
     //server socket to.
 
-    //sock can optionally be specified in order to use a preexisting
+    //socket can optionally be specified in order to use a preexisting
     //socket object.
 
     //backlog is the maximum number of queued connections passed to

src/asynchronous/libasync/events.d

@@ -214,7 +214,8 @@ package class LibasyncEventLoop : EventLoop
         ProtocolType protocolType = UNSPECIFIED!ProtocolType,
         AddressInfoFlags addressInfoFlags = UNSPECIFIED!AddressInfoFlags)
     {
-        // no async implementation in libasync yet, use the std.socket.getAddresInfo implementation;
+        // no async implementation in libasync yet, use the
+        // std.socket.getAddresInfo implementation;
         return std.socket.getAddressInfo(host, service, addressFamily,
             socketType, protocolType, addressInfoFlags);
     }

src/asynchronous/locks.d

@@ -150,7 +150,7 @@ final class Lock
  * initially false.
  *
  * This class is not thread safe.
- */ 
+ */
 final class Event
 {
     private EventLoop eventLoop;
@@ -193,7 +193,7 @@ final class Event
 
     /**
      * Set the internal flag to true. All coroutines waiting for it to become
-     * true are awakened. Coroutine that call $(D_PSYMBOL wait()) once the flag
+     * true are awakened. Coroutines that call $(D_PSYMBOL wait()) once the flag
      * is true will not block at all.
      */
     void set()
@@ -327,7 +327,7 @@ final class Condition
     /**
      * Wake up all coroutines waiting on this condition. This method acts like
      * $(D_PSYMBOL notify()), but wakes up all waiting coroutines instead of
-     * one. If the calling coroutines has not acquired the lock when this method
+     * one. If the calling coroutine has not acquired the lock when this method
      * is called, an $(D_PSYMBOL Exception) is thrown.
      */
     void notifyAll()
@@ -388,8 +388,9 @@ final class Condition
     /**
      * Wait until a predicate becomes true.
      *
-     * The predicate should be a callable returning a boolean value. The final
-     * predicate value is the return value.
+     * The predicate should be a callable returning a boolean value.
+     *
+     * Returns true
      */
     @Coroutine
     bool waitFor(bool delegate() predicate)
@@ -501,7 +502,7 @@ class Semaphore
 
 /**
  * A bounded semaphore implementation.
- * 
+ *
  * This throws an Exception in $(D_PSYMBOL release()) if it would increase the
  * value above the initial value.
  */

src/asynchronous/queues.d

@@ -74,7 +74,7 @@ class Queue(T, size_t maxSize = 0)
             this.eventLoop = getEventLoop;
         else
             this.eventLoop = eventLoop;
-        
+
         this.finished = new Event(this.eventLoop);
         this.finished.set;
     }

src/asynchronous/streams.d

@@ -104,7 +104,7 @@ alias ClientConnectedCallback = void delegate(StreamReader, StreamWriter);
  *
  * The rest of the arguments are all the usual arguments to $(D_PSYMBOL
  * eventLoop.createServer()) except $(D_PSYMBOL protocolFactory). The return
- * value is the same as $(D_PSYMBOL eventLoop.create_server()).
+ * value is the same as $(D_PSYMBOL eventLoop.createServer()).
  *
  * Additional optional keyword arguments are loop (to set the event loop
  * instance to use) and limit (to set the buffer limit passed to the
@@ -325,7 +325,7 @@ class StreamReaderProtocol : FlowControlProtocol
 
         if (clientConnectedCallback !is null)
         {
-            streamWriter = new StreamWriter(eventLoop, transport1, this, 
+            streamWriter = new StreamWriter(eventLoop, transport1, this,
                 streamReader);
             eventLoop.createTask(clientConnectedCallback, streamReader,
                 streamWriter);
@@ -370,7 +370,7 @@ final class StreamReader
             this.eventLoop = getEventLoop;
         else
             this.eventLoop = eventLoop;
-        // The line length limit is  a security feature;
+        // The line length limit is a security feature;
         // it also doubles as half the buffer limit.
         this.limit = limit;
     }
@@ -443,7 +443,7 @@ final class StreamReader
     }
 
     /**
-     * Set the exception.
+     * Set the transport.
      */
     void setTransport(ReadTransport transport)
     in
@@ -487,7 +487,7 @@ final class StreamReader
     {
         // StreamReader uses a future to link the protocol feed_data() method
         // to a read coroutine. Running two read coroutines at the same time
-        // would have an unexpected behaviour. It would not possible to know
+        // would have an unexpected behavior. It would not be possible to know
         // which coroutine would get the next data.
         enforce(flowWaiter is null, functionName
             ~ "() called while another coroutine is already waiting for incoming data");
@@ -604,8 +604,9 @@ final class StreamReader
     /**
      * Read exactly $(D_PSYMBOL n) bytes. Raise an $(D_PSYMBOL
      * IncompleteReadError) if the end of the stream is reached before
-     * $(D_PSYMBOL n) can be read, the $(D_PSYMBOL IncompleteReadError.partial)
-     * attribute of the exception contains the partial read bytes.
+     * $(D_PSYMBOL n) bytes can be read, the $(D_PSYMBOL
+     * IncompleteReadError.partial) attribute of the exception contains the
+     * partial read bytes.
      */
     @Coroutine
     const(void)[] readExactly(size_t n)
@@ -708,7 +709,7 @@ final class StreamWriter
     }
 
     /**
-     * Let the write buffer of the underlying transport a chance to be flushed.
+     * Give the write buffer of the underlying transport a chance to be flushed.
      *
      * The intended use is to write:
      *
@@ -718,7 +719,7 @@ final class StreamWriter
      * When the size of the transport buffer reaches the high-water limit (the
      * protocol is paused), block until the size of the buffer is drained down
      * to the low-water limit and the protocol is resumed. When there is nothing
-     * to wait for, the continues immediately.
+     * to wait for, continue immediately.
      *
      * Calling $(D_PSYMBOL drain()) gives the opportunity for the loop to
      * schedule the write operation and flush the buffer. It should especially

src/asynchronous/tasks.d

@@ -156,7 +156,7 @@ interface TaskHandle : FutureHandle
 
         if (thisTask.injectException !is null)
             throw thisTask.injectException;
-    }    
+    }
 }
 
 private class TaskFiber : Fiber
@@ -216,7 +216,7 @@ static this()
  * different threads. While a task waits for the completion of a future, the
  * event loop executes a new task.
  *
- * The cancellation of a task is different from the cancelation of a future.
+ * The cancellation of a task is different from the cancellation of a future.
  * Calling $(D_PSYMBOL cancel()) will throw a $(D_PSYMBOL CancelledException)
  * to the wrapped fiber. $(D_PSYMBOL cancelled()) only returns $(D_KEYWORD
  * true) if the wrapped fiber did not catch the $(D_PSYMBOL
@@ -419,8 +419,8 @@ unittest
 }
 
 /**
- * Return an generator whose values, when waited for, are Future instances in
- * the order in which and as soon as they complete.
+ * Return a generator whose values, when waited for, are Future instances in
+ * the order they complete.
  *
  * Raises $(D_PSYMBOL TimeoutException) if the timeout occurs before all futures
  * are done.
@@ -627,7 +627,7 @@ unittest
  * cancel $(D_PSYMBOL shield()).
  *
  * If you want to completely ignore cancellation (not recommended) you can
- * combine $(D_PSYMBOL shield()) with a try/except clause, as follows:
+ * combine $(D_PSYMBOL shield()) with a try/catch clause, as follows:
  *
  * $(D_CODE
  *   try
@@ -880,8 +880,8 @@ unittest
  *
  *  future = future to wait for.
  *
- *  timeout = can be used to control the maximum number of seconds to wait
- *      before returning. If $(PARAM timeout) is 0 or negative, block until the
+ *  timeout = can be used to control the maximum time to wait before
+ *      returning. If $(PARAM timeout) is 0 or negative, block until the
  *      future completes.
  *
  * Returns: result of the future. When a timeout occurs, it cancels the task
@@ -1046,7 +1046,7 @@ class GeneratorTask(T) : Task!(void delegate())
 
 /**
  * Yield a value to the caller of the currently executing generator task. The
- * type of the yielded value and of type of the generator must be the same;
+ * type of the yielded value and the type of the generator must be the same.
  */
 @Coroutine
 void yieldValue(T)(auto ref T value)

src/asynchronous/transports.d

@@ -108,20 +108,20 @@ interface WriteTransport : BaseTransport
     /**
      * Set the high- and low-water limits for write flow control.
      *
-     * These two values control when call the protocol's $(D_PSYMBOL
+     * These two values control when the protocol's $(D_PSYMBOL
      * pauseWriting()) and $(D_PSYMBOL resumeWriting()) methods are called. If
      * specified, the low-water limit must be less than or equal to the
      * high-water limit.
-     * 
-     * The defaults are implementation-specific.  If only the high-water limit
-     * is given, the low-water limit defaults to a implementation-specific value
-     * less than or equal to the high-water limit.  Setting $(D_PSYMBOL high) to
-     * zero forces low to zero as well, and causes $(D_PSYMBOL pauseWriting())
-     * to be called whenever the buffer becomes non-empty. Setting $(D_PSYMBOL
-     * low) to zero causes $(D_PSYMBOL resumeWriting()) to be called only once
-     * the buffer is empty. Use of zero for either limit is generally
-     * sub-optimal as it reduces opportunities for doing I/O and computation
-     * concurrently.
+     *
+     * The defaults are implementation-specific. If only the high-water limit
+     * is given, the low-water limit defaults to an implementation-specific
+     * value less than or equal to the high-water limit. Setting $(D_PSYMBOL
+     * high) to zero forces low to zero as well, and causes $(D_PSYMBOL
+     * pauseWriting()) to be called whenever the buffer becomes
+     * non-empty. Setting $(D_PSYMBOL low) to zero causes $(D_PSYMBOL
+     * resumeWriting()) to be called only once the buffer is empty. Use of
+     * zero for either limit is generally sub-optimal as it reduces
+     * opportunities for doing I/O and computation concurrently.
      */
     void setWriteBufferLimits(Nullable!size_t high = Nullable!size_t(),
         Nullable!size_t low = Nullable!size_t());
@@ -175,8 +175,7 @@ interface DatagramTransport : BaseTransport
      * transport-dependent target address).
      *
      * If $(D_PSYMBOL address) is $(D_KEYWORD null), the data is sent to the
-     * target address given on transport
-     * creation.
+     * target address given on transport creation.
      *
      * This method does not block; it buffers the data and arranges for it to be
      * sent out asynchronously.
@@ -203,7 +202,6 @@ interface SubprocessTransport : BaseTransport
      */
     Pid getPid();
 
-
     /**
      * Returns: the transport for the communication pipe corresponding to the
      * integer file descriptor fd: