Skip to content

Commit 994df88

Browse files
authored
Merge pull request #621 from microsoft/emolsh/api-ref-docs-dialogstate
emolsh/api-ref-docs-dialogstate
2 parents 2217314 + 9759e56 commit 994df88

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

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

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,31 @@
44
from typing import List
55
from .dialog_instance import DialogInstance
66

7-
87
class DialogState:
8+
"""
9+
Contains state information for the dialog stack.
10+
"""
911
def __init__(self, stack: List[DialogInstance] = None):
12+
"""
13+
Initializes a new instance of the :class:`DialogState` class.
14+
The new instance is created with an empty dialog stack.
15+
16+
:param stack: The state information to initialize the stack with.
17+
:type stack: List[:class:`DialogInstance`]
18+
"""
1019
if stack is None:
1120
self._dialog_stack = []
1221
else:
1322
self._dialog_stack = stack
1423

1524
@property
1625
def dialog_stack(self):
26+
"""
27+
Initializes a new instance of the :class:`DialogState` class.
28+
29+
:return: The state information to initialize the stack with.
30+
:rtype: List
31+
"""
1732
return self._dialog_stack
1833

1934
def __str__(self):

0 commit comments

Comments
 (0)