Add a note about RecoveryCompleted for new actors

drewhk · Nov 4, 2016 · 9390519 · 9390519
1 parent 20942b3
commit 9390519
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/akka-docs/rst/java/persistence.rst b/akka-docs/rst/java/persistence.rst
@@ -195,6 +195,10 @@ and before any other received messages.
 
 .. includecode:: code/docs/persistence/PersistenceDocTest.java#recovery-completed
 
+The actor will always receive a :class:`RecoveryCompleted` message, even if there are no events
+in the journal and the snapshot store is empty, or if it's a new persistent actor with a previously
+unused ``persistenceId``.
+
 If there is a problem with recovering the state of the actor from the journal, ``onRecoveryFailure``
 is called (logging the error by default) and the actor will be stopped.
 

diff --git a/akka-docs/rst/scala/persistence.rst b/akka-docs/rst/scala/persistence.rst
@@ -180,6 +180,10 @@ and before any other received messages.
 
 .. includecode:: code/docs/persistence/PersistenceDocSpec.scala#recovery-completed
 
+The actor will always receive a :class:`RecoveryCompleted` message, even if there are no events
+in the journal and the snapshot store is empty, or if it's a new persistent actor with a previously
+unused ``persistenceId``.
+
 If there is a problem with recovering the state of the actor from the journal, ``onRecoveryFailure``
 is called (logging the error by default) and the actor will be stopped.