8000 Merge pull request #905 from microsoft/emolsh/ref-fix-0401 · Santhosh0505/botbuilder-python@1d40a57 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1d40a57

Browse files
tracyboehrertracyboehrer
authored
Merge pull request microsoft#905 from microsoft/emolsh/ref-fix-0401
Reference doc update - 194592
2 parents cdd00e1 + 5e58c25 commit 1d40a57

File tree

5 files changed

+6
-10
lines changed

5 files changed

+6
-10
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,6 @@ async def end_dialog(
164164
:param context: The context object for this turn.
165165
:type context: :class:`botbuilder.core.TurnContext`
166166
:param instance: State information associated with the instance of this component dialog.
167-
on its parent's dialog stack.
168167
:type instance: :class:`botbuilder.dialogs.DialogInstance`
169168
:param reason: Reason why the dialog ended.
170169
:type reason: :class:`botbuilder.dialogs.DialogReason`

‎libraries/botbuilder-dialogs/botbuilder/dialogs/dialog_context.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def active_dialog(self):
6666
async def begin_dialog(self, dialog_id: str, options: object = None):
6767
"""
6868
Pushes a new dialog onto the dialog stack.
69-
:param dialog_id: ID of the dialog to start..
69+
:param dialog_id: ID of the dialog to start
7070
:param options: (Optional) additional argument(s) to pass to the dialog being started.
7171
"""
7272
if not dialog_id:

‎libraries/botbuilder-dialogs/botbuilder/dialogs/dialog_reason.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ class DialogReason(Enum):
1313
:vartype ContinueCalled: int
1414
:var EndCalled: A dialog ended normally through a call to :meth:`DialogContext.end_dialog()
1515
:vartype EndCalled: int
16-
:var ReplaceCalled: A dialog is ending because it's being replaced through a call to
17-
:meth:``DialogContext.replace_dialog()`.
16+
:var ReplaceCalled: A dialog is ending and replaced through a call to :meth:``DialogContext.replace_dialog()`.
1817
:vartype ReplacedCalled: int
1918
:var CancelCalled: A dialog was cancelled as part of a call to :meth:`DialogContext.cancel_all_dialogs()`.
2019
:vartype CancelCalled: int

‎libraries/botbuilder-dialogs/botbuilder/dialogs/dialog_state.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def __init__(self, stack: List[DialogInstance] = None):
1515
Initializes a new instance of the :class:`DialogState` class.
1616
1717
:param stack: The state information to initialize the stack with.
18-
:type stack: :class:`typing.List[:class:`DialogInstance`]`
18+
:type stack: :class:`typing.List`
1919
"""
2020
if stack is None:
2121
self._dialog_stack = []
@@ -28,7 +28,7 @@ def dialog_stack(self):
2828
Initializes a new instance of the :class:`DialogState` class.
2929
3030
:return: The state information to initialize the stack with.
31-
:rtype: :class:`typing.List[:class:`DialogInstance`]`
31+
:rtype: :class:`typing.List`
3232
"""
3333
return self._dialog_stack
3434

‎libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,7 @@ async def on_prompt(
211211
:type turn_context: :class:`botbuilder.core.TurnContext`
212212
:param state: Contains state for the current instance of the prompt on the dialog stack
213213
:type state: :class:`Dict`
214-
:param options: A prompt options object constructed from the options initially provided
215-
in the call :meth:`DialogContext.prompt()`
214+
:param options: A prompt options object constructed from:meth:`DialogContext.prompt()`
216215
:type options: :class:`PromptOptions`
217216
:param is_retry: true if is the first time the user for input; otherwise, false
218217
:type is_retry: bool
@@ -235,8 +234,7 @@ async def on_recognize(
235234
:type tu 62F1 rn_context: :class:`botbuilder.core.TurnContext`
236235
:param state: Contains state for the current instance of the prompt on the dialog stack
237236
:type state: :class:`Dict`
238-
:param options: A prompt options object constructed from the options initially provided
239-
in the call to :meth:`DialogContext.prompt()`
237+
:param options: A prompt options object constructed from :meth:`DialogContext.prompt()`
240238
:type options: :class:`PromptOptions`
241239
242240
:return: A task representing the asynchronous operation.

0 commit comments

Comments
 (0)
0