update documentation for regi-python - #19
Conversation
add migration and API documentation for regi-python
4cca65d to
4350249
Compare
rma-psmorris
left a comment
rma-psmorris
left a comment
There was a problem hiding this comment.
A little bit of feedback
| - python to java bridge code | ||
| - prefer modern Python style and small, testable helpers | ||
| - `district-scripts/` | ||
| - active district-owned operational scripts |
There was a problem hiding this comment.
Wanted to clarify if the district scripts here will be bundled in the wheel, or if districts will have their scripts in their Batch repos.
i.e.
usace-watermanagement/swt-wm-cwbi-jobs
The word active could mean these are the primary scripts. James and I were discussing if the scripts are in the above -wm- repo if there would be a desync issue. But probably not a problem since they rarely update and this repo is just doing a best check against previously known scripts?
There was a problem hiding this comment.
While we could bundle the scripts, I think it would defeat the purpose to require rebundling this library for script updates. The intent is that the actual production scripts be in repos like usace-watermanagement/swt-wm-cwbi-jobs.
I wanted to convey specifically to agents reading the AGENTS.md that the scripts included here represent the "active" production scripts. At least in my testing with Claude/Codex/Junie that has been sufficient to keep the agents from trying to change these files during library updates and to keep the library user's public API functionality intact (without explicit directory to make a breaking change).
krowvin
left a comment
krowvin
left a comment
There was a problem hiding this comment.
just had one other comment, not a blocker
4 participants
add migration and API documentation for regi-python