Fix documentation as per #283

docs/index.md

@@ -902,7 +902,7 @@ An actor is a self-contained execution unit with well-defined inputs and outputs
 
 All actors extends the [`Actor`]({{javadoc}}/actors/Actor.html) class. The constructor takes the actor's name (which does not have to be unique, and may even be `null`), and its mailbox settings (of type [`MailboxConfig`]({{javadoc}}/actors/MailboxConfig.html)).
 
-`MailboxConfig` defines the mailbox size (the number of messages that can wait in the mailbox channel), with `-1` specifying an unbounded mailbox, and an *overflow policy*. The overflow policy works the same as for plain channels, except that the `THROW` policy doesn't cause an exception to be thrown in the sender if the mailbox capacity is exceeded, but rather throws an exception into the receiving actor (the exception will be thrown when the actor next blocks on a `receive`).
+`MailboxConfig` defines the mailbox size (the number of messages that can wait in the mailbox channel), with `-1` specifying an unbounded mailbox, and an *overflow policy*. The overflow policy is currently ignored. If the mailbox capacity is exceeded, an exception will be thrown *inside* the receiving actor when the actor next blocks on a `receive`.
 
 An actor is required to implement the [`doRun`]({{javadoc}}/actors/Actor.html#doRun()) method. This method is the actor body, and is run when the actor is spawned.
 

quasar-actors/src/main/java/co/paralleluniverse/actors/MailboxConfig.java

@@ -26,6 +26,9 @@ public class MailboxConfig implements java.io.Serializable {
 
     /**
      * Specifies a mailbox configuration with a given size and overflow policy.
+     * <p/>
+     * <b>Note: The overflow policy is currently ignored. An mailbox overflow will result in an exception being thrown inside
+     * the actor by {@code receive()} regardless of policy.</b>
      *
      * @param mailboxSize The number of messages that can wait in the mailbox channel, with {@code -1} specifying an unbounded mailbox.
      * @param policy      Specifies what to do when the mailbox is full and a new message is added.