Upload README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,49 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Table of Contents
|
2 |
+
|
3 |
+
* [CodeFileEditAtomicFlow](#CodeFileEditAtomicFlow)
|
4 |
+
* [CodeFileEditAtomicFlow](#CodeFileEditAtomicFlow.CodeFileEditAtomicFlow)
|
5 |
+
* [run](#CodeFileEditAtomicFlow.CodeFileEditAtomicFlow.run)
|
6 |
+
* [\_\_init\_\_](#__init__)
|
7 |
+
|
8 |
+
<a id="CodeFileEditAtomicFlow"></a>
|
9 |
+
|
10 |
+
# CodeFileEditAtomicFlow
|
11 |
+
|
12 |
+
<a id="CodeFileEditAtomicFlow.CodeFileEditAtomicFlow"></a>
|
13 |
+
|
14 |
+
## CodeFileEditAtomicFlow Objects
|
15 |
+
|
16 |
+
```python
|
17 |
+
class CodeFileEditAtomicFlow(AtomicFlow)
|
18 |
+
```
|
19 |
+
|
20 |
+
This class is used to write code to a temp code file, with commented instructions to give information
|
21 |
+
to the user.
|
22 |
+
|
23 |
+
*Input Interface*:
|
24 |
+
- `code`: str
|
25 |
+
- `language_of_code`: str
|
26 |
+
- `memory_files`: Dict[str, str]
|
27 |
+
|
28 |
+
*Output Interface*:
|
29 |
+
- `code_editor_output`: str
|
30 |
+
- `temp_code_file_location`: str
|
31 |
+
|
32 |
+
<a id="CodeFileEditAtomicFlow.CodeFileEditAtomicFlow.run"></a>
|
33 |
+
|
34 |
+
#### run
|
35 |
+
|
36 |
+
```python
|
37 |
+
def run(input_data: Dict[str, Any])
|
38 |
+
```
|
39 |
+
|
40 |
+
This function runs the atomic flow.
|
41 |
+
|
42 |
+
:param input_data (Dict[str, Any]): The input data.
|
43 |
+
:return: Dict[str, Any] The output data.
|
44 |
+
|
45 |
+
|
46 |
+
<a id="__init__"></a>
|
47 |
+
|
48 |
+
# \_\_init\_\_
|
49 |
+
|