Upload README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,33 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Table of Contents
|
| 2 |
+
|
| 3 |
+
* [PlanFileEditAtomicFlow](#PlanFileEditAtomicFlow)
|
| 4 |
+
* [PlanFileEditAtomicFlow](#PlanFileEditAtomicFlow.PlanFileEditAtomicFlow)
|
| 5 |
+
* [\_\_init\_\_](#__init__)
|
| 6 |
+
|
| 7 |
+
<a id="PlanFileEditAtomicFlow"></a>
|
| 8 |
+
|
| 9 |
+
# PlanFileEditAtomicFlow
|
| 10 |
+
|
| 11 |
+
<a id="PlanFileEditAtomicFlow.PlanFileEditAtomicFlow"></a>
|
| 12 |
+
|
| 13 |
+
## PlanFileEditAtomicFlow Objects
|
| 14 |
+
|
| 15 |
+
```python
|
| 16 |
+
class PlanFileEditAtomicFlow(AtomicFlow)
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
This class is used to write plan to a temp code file, with commented instructions to give information
|
| 20 |
+
to the user.
|
| 21 |
+
|
| 22 |
+
*Input Interface*:
|
| 23 |
+
- `plan`: str
|
| 24 |
+
- `plan_file_location`: str
|
| 25 |
+
|
| 26 |
+
*Output Interface*:
|
| 27 |
+
- `plan_editor_output`: str
|
| 28 |
+
- `temp_plan_file_location`: str
|
| 29 |
+
|
| 30 |
+
<a id="__init__"></a>
|
| 31 |
+
|
| 32 |
+
# \_\_init\_\_
|
| 33 |
+
|