README and change log for the Python bindings are hard to find #2200
Labels
subsystem: saw-python
Related to the Python bindings for the RPC SAW server
tech debt
Issues that document or involve technical debt
type: bug
Issues reporting bugs or unexpected/unwanted behavior
usability
An issue that impedes efficient understanding and use
Milestone
The README file with the basic user-facing info for the Python bindings, and the accompanying change log, lives in saw-script/saw-remote-api/python, which is not an obvious place. (Especially since there's another, less user-facing, change log in saw-script/saw-remote-api.)
This is partly a documentation issue but mostly a repository organization problem. SAW is one project, however many sub-projects and cabal configs it may currently sport, and in particular the Python API is not supposed to be a second-class citizen.
It isn't yet clear yet what the eventual organization of the saw-script repository should be, and therefore it's not clear if these files should be merged into the top-level ones, or if this material for the Python and SAWScript interfaces should live in separate subtrees. Changing things around prematurely probably isn't worthwhile. But the current situation with these files is unsatisfactory and that shouldn't get forgotten.
The text was updated successfully, but these errors were encountered: