minor changes to doco

Author: aprilwebster

examples/conversation_tone_analyzer_integration/README.md

@@ -2,9 +2,9 @@
 
 This example provides sample code for integrating [Tone Analyzer][tone_analyzer] and [Conversation][conversation].
 
-  * [tone_detection.py][tone_conversation_integration_example_tone_detection] - sample code to initialize a user object in the conversation payload's context (initUser), and to update tone in the user object in the conversation payload's context (updateUserTone).
+  * [tone_detection.py][tone_conversation_integration_example_tone_detection] - sample code to initialize a user object in the conversation payload's context (initUser), to call Tone Analyzer to retrieve tone for a user's input (invokeToneAsync), and to update tone in the user object in the conversation payload's context (updateUserTone).
 
-  * [tone_conversation_integration.v1.py][tone_conversation_integration_example] - sample code to use tone_detection.py to get and add tone to the payload and send a request to the Conversation Service's message endpoint.
+  * [tone_conversation_integration.v1.py][tone_conversation_integration_example] - sample code to use tone_detection.py to get and add tone to the payload and send a request to the Conversation Service's message endpoint both in a synchronous and asynchronous manner.
 
 
 Requirements to run the sample code

examples/conversation_tone_analyzer_integration/__init__.py

@@ -12,12 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# TODO: are these needed?
 from .watson_developer_cloud_service import WatsonDeveloperCloudService
 from .watson_developer_cloud_service import WatsonException
 from .watson_developer_cloud_service import WatsonInvalidArgument
 from .conversation_v1 import ConversationV1
 from .tone_analyzer_v3 import ToneAnalyzerV3
 
-# TODO: do I need the version library?
+
 from .version import __version__

examples/conversation_tone_analyzer_integration/tone_conversation_integration.v1.py

@@ -12,7 +12,7 @@
 # load the .env file containing your environment variables for the required services (conversation and tone)
 load_dotenv(find_dotenv())
 
-# replace with your own conversation credentials or put them in a .env file in the home directory
+# replace with your own conversation credentials or put them in a .env file
 conversation = ConversationV1(
     username=os.environ.get('CONVERSATION_USERNAME') or 'YOUR SERVICE NAME',
     password=os.environ.get('CONVERSATION_PASSWORD') or 'YOUR PASSWORD',
@@ -63,7 +63,7 @@ async def invokeToneConversationAsync (payload, maintainToneHistoryInContext):
     print(json.dumps(response, indent=2))
 
 
-# how to invoke both versions of the tone aware calls to conversation
+# invoke tone aware calls to conversation - either synchronously or asynchronously
 
 # synchronous call to conversation with tone included in the context
 invokeToneConversation(payload,maintainToneHistoryInContext)