nbaldwin commited on
Commit
535564d
·
1 Parent(s): d8611d2

Proper Doc

Browse files
Files changed (1) hide show
  1. README.md +9 -7
README.md CHANGED
@@ -1,10 +1,10 @@
1
  ---
2
  license: mit
3
  ---
4
-
5
  # Table of Contents
6
 
7
  * [HumanStandardInputFlow](#HumanStandardInputFlow)
 
8
  * [HumanStandardInputFlow](#HumanStandardInputFlow.HumanStandardInputFlow)
9
  * [instantiate\_from\_config](#HumanStandardInputFlow.HumanStandardInputFlow.instantiate_from_config)
10
  * [run](#HumanStandardInputFlow.HumanStandardInputFlow.run)
@@ -13,6 +13,12 @@ license: mit
13
 
14
  # HumanStandardInputFlow
15
 
 
 
 
 
 
 
16
  <a id="HumanStandardInputFlow.HumanStandardInputFlow"></a>
17
 
18
  ## HumanStandardInputFlow Objects
@@ -75,16 +81,12 @@ Instantiates the flow from a config file.
75
  #### run
76
 
77
  ```python
78
- def run(input_data: Dict[str, Any]) -> Dict[str, Any]
79
  ```
80
 
81
  Runs the HumanStandardInputFlow. It's used to read input from the user/human's standard input.
82
 
83
  **Arguments**:
84
 
85
- - `input_data` (`Dict[str, Any]`): The input data dictionary
86
-
87
- **Returns**:
88
-
89
- `Dict[str, Any]`: The output data dictionary
90
 
 
1
  ---
2
  license: mit
3
  ---
 
4
  # Table of Contents
5
 
6
  * [HumanStandardInputFlow](#HumanStandardInputFlow)
7
+ * [log](#HumanStandardInputFlow.log)
8
  * [HumanStandardInputFlow](#HumanStandardInputFlow.HumanStandardInputFlow)
9
  * [instantiate\_from\_config](#HumanStandardInputFlow.HumanStandardInputFlow.instantiate_from_config)
10
  * [run](#HumanStandardInputFlow.HumanStandardInputFlow.run)
 
13
 
14
  # HumanStandardInputFlow
15
 
16
+ <a id="HumanStandardInputFlow.log"></a>
17
+
18
+ #### log
19
+
20
+ ToDo: Is there a better fix?
21
+
22
  <a id="HumanStandardInputFlow.HumanStandardInputFlow"></a>
23
 
24
  ## HumanStandardInputFlow Objects
 
81
  #### run
82
 
83
  ```python
84
+ def run(input_message: FlowMessage)
85
  ```
86
 
87
  Runs the HumanStandardInputFlow. It's used to read input from the user/human's standard input.
88
 
89
  **Arguments**:
90
 
91
+ - `input_message` (`FlowMessage`): The input message
 
 
 
 
92