Update component_dialog.py

Author: Emily Olshefski

libraries/botbuilder-dialogs/botbuilder/dialogs/component_dialog.py

@@ -88,14 +88,14 @@ async def continue_dialog(self, dialog_context: DialogContext) -> DialogTurnResu
             contain a return value.
 
             If this method is *not* overriden the component dialog calls the
-            :meth:`DialogContext.continue_dialog` method on it's inner dialog
+            :meth:`botbuilder.dialogs.DialogContext.continue_dialog` method on it's inner dialog
             context. If the inner dialog stack is empty, the component dialog ends,
-            and if a :class:`DialogTurnResult.result` is available, the component dialog
+            and if a :var:`botbuilder.dialogs.DialogTurnResult.result` is available, the component dialog
             uses that as it's return value.
 
 
-        :param dialog_context: The parent :class:`DialogContext` for the current turn of the conversation.
-        :type dialog_context: :class:`DialogContext`
+        :param dialog_context: The parent :class:`botbuilder.dialogs.DialogContext` for the current turn of the conversation.
+        :type dialog_context: :class:`botbuilder.dialogs.DialogContext`
         :return: Signals the end of the turn
         :rtype: :var:`Dialog.end_of_turn`
         """
@@ -126,8 +126,8 @@ async def resume_dialog(
             To avoid the container prematurely ending we need to implement this method and simply
             ask our inner dialog stack to re-prompt.
 
-        :param dialog_context: The :class:`DialogContext` for the current turn of the conversation.
-        :type dialog_context: :class:`DialogContext`
+        :param dialog_context: The :class:`botbuilder.dialogs.DialogContext` for the current turn of the conversation.
+        :type dialog_context: :class:`botbuilder.dialogs.DialogContext`
         :param reason: Reason why the dialog resumed.
         :type reason: :class:`DialogReason`
         :param result: Optional, value returned from the dialog that was called.
@@ -148,7 +148,7 @@ async def reprompt_dialog(
         :param context: The context object for this turn.
         :type context: :class:`botbuilder.core.TurnContext`
         :param instance: State information for this dialog.
-        :type instance: :class:`DialogInstance`
+        :type instance: :class:`botbuilder.dialogs.DialogInstance`
         """
         # Delegate to inner dialog.
         dialog_state = instance.state[self.persisted_dialog_state]
@@ -167,9 +167,9 @@ async def end_dialog(
         :param context: The context object for this turn.
         :type context: :class:`botbuilder.core.TurnContext`
         :param instance: State information associated with the instance of this component dialog.
-        :type instance: :class:`DialogInstance`
+        :type instance: :class:`botbuilder.dialogs.DialogInstance`
         :param reason: Reason why the dialog ended.
-        :type reason: :class:`DialogReason`
+        :type reason: :class:`botbuilder.dialogs.DialogReason`
         """
         # Forward cancel to inner dialog
         if reason == DialogReason.CancelCalled:
@@ -183,7 +183,7 @@ def add_dialog(self, dialog: Dialog) -> object:
         Adds a :class:`Dialog` to the component dialog and returns the updated component.
 
         :param dialog: The dialog to add.
-        :type dialog: :class:`Dialog`
+        :type dialog: :class:`botbuilder.dialogs.Dialog`
         :return self: The updated :class:`ComponentDialog`
         :rtype self: :class:`ComponentDialog`
         """
@@ -198,7 +198,7 @@ def find_dialog(self, dialog_id: str) -> Dialog:
 
         :param dialog_id: The dialog to add.
         :type dialog_id: str
-        :return: The :class:`Dialog`; or None if there is not a match for the ID.
+        :return: The :class:`botbuilder.dialogs.Dialog`; or None if there is not a match for the ID.
         """
         return self._dialogs.find(dialog_id)
 
@@ -212,13 +212,13 @@ async def on_begin_dialog(
             If the task is successful, the result indicates whether the dialog is still
             active after the turn has been processed by the dialog.
 
-            By default, this calls the :meth:`Dialog.begin_dialog()` method of the component
+            By default, this calls the :meth:`botbuilder.dialogs.Dialog.begin_dialog()` method of the component
             dialog's initial dialog.
 
             Override this method in a derived class to implement interrupt logic.
 
-        :param inner_dc: The inner :class:`DialogContext` for the current turn of conversation.
-        :type inner_dc: :class:`DialogContext`
+        :param inner_dc: The inner :class:`botbuilder.dialogs.DialogContext` for the current turn of conversation.
+        :type inner_dc: :class:`botbuilder.dialogs.DialogContext`
         :param options: Optional, initial information to pass to the dialog.
         :type options: object
         """
@@ -228,8 +228,8 @@ async def on_continue_dialog(self, inner_dc: DialogContext) -> DialogTurnResult:
         """
         Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.
 
-        :param inner_dc: The inner :class:`DialogContext` for the current turn of conversation.
-        :type inner_dc: :class:`DialogContext`
+        :param inner_dc: The inner :class:`botbuilder.dialogs.DialogContext` for the current turn of conversation.
+        :type inner_dc: :class:`botbuilder.dialogs.DialogContext`
         """
         return await inner_dc.continue_dialog()
 
@@ -242,9 +242,9 @@ async def on_end_dialog(  # pylint: disable=unused-argument
         :param turn_context: The :class:`botbuilder.core.TurnContext` for the current turn of the conversation.
         :type turn_context: :class:`botbuilder.core.TurnContext`
         :param instance: State information associated with the instance of this component dialog.
-        :type instance: :class:`DialogInstance`
+        :type instance: :class:`botbuilder.dialogs.DialogInstance`
         :param reason: Reason why the dialog ended.
-        :type reason: :class:`DialogReason`
+        :type reason: :class:`botbuilder.dialogs.DialogReason`
         """
         return
 
@@ -253,9 +253,9 @@ async def on_reprompt_dialog(  # pylint: disable=unused-argument
     ) -> None:
         """
         :param turn_context: The :class:`botbuilder.core.TurnContext` for the current turn of the conversation.
-        :type turn_context: :class:`DialogInstance`
+        :type turn_context: :class:`botbuilder.dialogs.DialogInstance`
         :param instance: State information associated with the instance of this component dialog.
-        :type instance: :class:`DialogInstance`
+        :type instance: :class:`botbuilder.dialogs.DialogInstance`
         """
         return
 
@@ -270,19 +270,19 @@ async def end_component(
             turn was processed by the dialog.
 
             In general, the parent context is the dialog or bot turn handler that started the dialog.
-            If the parent is a dialog, the stack calls the parent's :meth:`Dialog.resume_dialog()` method
+            If the parent is a dialog, the stack calls the parent's :meth:`botbuilder.dialogs.Dialog.resume_dialog()` method
             to return a result to the parent dialog. If the parent dialog does not implement
-            :meth:`Dialog.resume_dialog()`, then the parent will end, too, and the result is passed to the next
+            :meth:`botbuilder.dialogs.Dialog.resume_dialog()`, then the parent will end, too, and the result is passed to the next
             parent context, if one exists.
 
-            The returned :class:`DialogTurnResult`contains the return value in its
-            :class:`DialogTurnResult.result` property.
+            The returned :class:`botbuilder.dialogs.DialogTurnResult`contains the return value in its
+            :var:`botbuilder.dialogs.DialogTurnResult.result` property.
 
-        :param outer_dc: The parent :class:`DialogContext` for the current turn of conversation.
-        :type outer_dc: :class:`DialogContext`
+        :param outer_dc: The parent :class:`botbuilder.dialogs.DialogContext` for the current turn of conversation.
+        :type outer_dc: :class:`botbuilder.dialogs.DialogContext`
         :param result: Optional, value to return from the dialog component to the parent context.
         :type result: object
         :return : Value to return.
-        :rtype: :var:`DialogTurnResult.result`
+        :rtype: :var:`botbuilder.dialogs.DialogTurnResult.result`
         """
         return await outer_dc.end_dialog(result)