Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README and change log for the Python bindings are hard to find #2200

Open
sauclovian-g opened this issue Jan 28, 2025 · 0 comments
Open

README and change log for the Python bindings are hard to find #2200

sauclovian-g opened this issue Jan 28, 2025 · 0 comments
Assignees
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

Comments

@sauclovian-g
Copy link
Contributor

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.

@sauclovian-g sauclovian-g added 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 labels Jan 28, 2025
@sauclovian-g sauclovian-g added this to the Someday milestone Jan 28, 2025
@sauclovian-g sauclovian-g self-assigned this Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant