Refactor agentql repo
#97
Conversation
Two questions!
or
|
Regarding the first question, I think we previously aligned that we would go with Examples and then js, python subfolders. But if we want to change it, I could also make the adjustments. And I have updated README in the latest commit. Thank you for flagging it! |
.templates/Python/async_template.py
Outdated
There was a problem hiding this comment.
please don't use capitalized folder names
javascript-sdk/.eslintrc.js
Outdated
There was a problem hiding this comment.
does it have to be "javascript-sdk"? So verbose. Can it be just "js"?
There was a problem hiding this comment.
Oh I think javascript-sdk is already removed from this repo with this PR. The reason it's showing up is because the files it contained were deleted (along with this folder).
There was a problem hiding this comment.
The actual js folder is under examples/js
.vscode/settings.json
Outdated
| ], | ||
| "python.analysis.typeCheckingMode": "standard", | ||
| "python.analysis.typeCheckingMode": "basic", |
There was a problem hiding this comment.
why and what's the difference?
There was a problem hiding this comment.
My initial thinking is that "basic" is more lenient in terms of reporting static type warnings/errors and might make it easier for others to contribute. But on a second thought, we should probably still make it standard to ensure code quality -- I will revert the change
.templates/python/sync_template.py
Outdated
There was a problem hiding this comment.
might be better to name them "template_*", using suffixes. but in any case, we'll need to address one thing: CLI tool will fail downloading the template. Can you double check, do we download from main of from a specific commit? cc @frankfeng98
There was a problem hiding this comment.
We could download from a specific branch, but probably not specific commit. Therefore, we need to update and release CLI (with links pointing to new file path) and merge this PR roughly at the same time.
The merging of this PR will wait and coordinate with Doc website release, as we will need to update example links on website as well.
What this PR does:
(1) Refactor the structure of the folder to align with this:
https://tinyfishgroup.slack.com/archives/C07NPTE4UNA/p1730482953278499
(2) Adjust the Github action workflow so that it will now run separately for Python and JS.
(3) Rename Python files to
main.py.The reason I put these together and this PR does multiple things is because it will make it easier to coordinate with changes on documentation website.