From 9e24ae2580202b9db2b091fb07f90b8a62b9aa8e Mon Sep 17 00:00:00 2001 From: Michael Miele Date: Mon, 13 Jan 2020 16:37:28 -0800 Subject: [PATCH 1/2] Update prompt_options.py Added ref documentation --- .../dialogs/prompts/prompt_options.py | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py index 8d9801424..2a3d6ef38 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py @@ -8,6 +8,10 @@ class PromptOptions: + """ Contains prompt settings + Contains settings to pass to a :class:`Prompt` object when the prompt is started. + """ + def __init__( self, prompt: Activity = None, @@ -17,6 +21,22 @@ def __init__( validations: object = None, number_of_attempts: int = 0, ): + """ Sets the initial prompt to send to the user as an :class:`botbuilder.schema.Activity`. + + :param prompt: The initial prompt to send to the user + :type prompt: :class:`botbuilder.schema.Activity` + :param retry_prompt: The retry prompt to send to the user + :type retry_prompt: :class:`botbuilder.schema.Activity` + :param choices: The choices to send to the user + :type choices: :class:`List` + :param style: The style of the list of choices to send to the user + :type style: :class:`ListStyle` + :param validations: The prompt validations + :type validations: :class:`Object` + :param number_of_attempts: The number of attempts allowed + :type number_of_attempts: :class:`int` + + """ self.prompt = prompt self.retry_prompt = retry_prompt self.choices = choices From 8fa2dee563975b2bf90068a6cf7a0312463a7317 Mon Sep 17 00:00:00 2001 From: Michael Miele Date: Fri, 24 Jan 2020 15:46:40 -0800 Subject: [PATCH 2/2] Update prompt_options.py Code comments formatting. --- .../botbuilder/dialogs/prompts/prompt_options.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py index 2a3d6ef38..ea0c74825 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py @@ -8,7 +8,7 @@ class PromptOptions: - """ Contains prompt settings + """ Contains settings to pass to a :class:`Prompt` object when the prompt is started. """ @@ -21,7 +21,8 @@ def __init__( validations: object = None, number_of_attempts: int = 0, ): - """ Sets the initial prompt to send to the user as an :class:`botbuilder.schema.Activity`. + """ + Sets the initial prompt to send to the user as an :class:`botbuilder.schema.Activity`. :param prompt: The initial prompt to send to the user :type prompt: :class:`botbuilder.schema.Activity`