summaryrefslogtreecommitdiffstats
path: root/docs/development/actors/overview.rst
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2020-05-12 15:23:19 -0400
committerJim Hahn <jrh3@att.com>2020-05-13 17:33:02 -0400
commit4805f3b7d150f2a4072826a2a7c90c9954bfeeaa (patch)
tree56619a0e49ac1d8f40c62d967d1fc4d3fe7b67e0 /docs/development/actors/overview.rst
parent1cecad6605bd0750336298a60b4fc05551351371 (diff)
Add documentation for APPC Legacy actor
Added documentation for APPC Legacy actor. Also added place-holders for the other actors. Issue-ID: POLICY-2515 Change-Id: I99af500ae36ea92a2aa8a9e75da5fc36982a63c6 Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'docs/development/actors/overview.rst')
-rw-r--r--docs/development/actors/overview.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/development/actors/overview.rst b/docs/development/actors/overview.rst
index 716f4f28..b9c24cec 100644
--- a/docs/development/actors/overview.rst
+++ b/docs/development/actors/overview.rst
@@ -122,7 +122,7 @@ XxxParams and XxxConfig
XxxConfig objects are
shared by all operations created by a single Operator. As a result, it should not
contain any data associated with an individual operation; such data should be stored
- within the operation object, itself
+ within the Operation object, itself
Junit tests
***********
@@ -177,7 +177,7 @@ Flow of operation
"standard" payload
- Subclasses may override *makeGuardPayload()* to add extra fields to the payload
(e.g., some SO operations add the VF count)
- - If any preprocessing step fails, then the "start" & "complete" callbacks will be
+ - If any preprocessing step fails, then the "start" and "complete" callbacks will be
invoked to indicate a failure of the operation as a whole. Otherwise, the flow will
continue on to *startOperationAsync()*, after the "start" callback is invoked
- *StartOperationAsync()* will perform whatever needs to be done to start the operation