Skip to content

Commit 1a6c52a

Browse files
committed
Add AI workflow documentation outlining code structure and requirements
1 parent 3d81ff7 commit 1a6c52a

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

Diff for: CODE fuzzy.ipynb renamed to .box/CODE fuzzy.ipynb

File renamed without changes.

Diff for: TEST fuzzy.ipynb renamed to .box/TEST fuzzy.ipynb

File renamed without changes.

Diff for: docs/ai workflow.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AI Query
2+
3+
* `Current code. Python 3.12 only, no backwards compatibility. I will post 3 files. Understand and acknowledge only, don't suggest anything.`
4+
* *post classes.py*
5+
* *post functions.py*
6+
* *post combinators.py*
7+
* `Now that I have posted and the code, let's start. Here is what I need help with:`
8+
9+
10+
# Required Code Structure
11+
12+
* The name of the file needs to be on the first line of the file as a comment like `# filename.py`
13+
so it can be easily copyed and pasted into a query.
14+
* Alternatively, we could use a module docstring with the filename in it. This would also be compatible with a hashbang.
15+
```
16+
#!/usr/bin/env python3
17+
"""
18+
pyping.py - This file does XYZ...
19+
"""
20+
```
21+
* Each file must be less than 10000 characters (about 300 lines) because queries are limited.
22+
* As the AI can figure out the logic of the code, line comments are not needed, and may even be distracting and counterproductive. Comments also take up valuable characters in the query, so they should be avoided.

0 commit comments

Comments
 (0)