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

Cleanup scratch vs. state vs. private namespaces #1417

Open
alerque opened this issue Jun 2, 2022 · 1 comment
Open

Cleanup scratch vs. state vs. private namespaces #1417

alerque opened this issue Jun 2, 2022 · 1 comment
Labels
refactor Code quality improvements todo

Comments

@alerque
Copy link
Member

alerque commented Jun 2, 2022

Right now we have an absolute scramble of packages with private variables, global scratch variables with inconsistent naming, and some global state variables with no documentation about what types and methods are expected.

I think we need to refactor this so that private implementation details are kept private, so that multiple SILE processes can be run at once (state and scratch don't clobber each other), and so that we know what changes to public APIs are considered breaking.

@alerque
Copy link
Member Author

alerque commented Jul 19, 2022

Huge progress has been made on this especially in #1373 and a lot of the package idempotency related commits, but there is more to do. We still have a bunch of global scratch stuff. Luckily most of it is undocumented and we can consider them private, so changing them won't be an official breaking change. But we're not quite out of the woods here yet...

@alerque alerque removed this from the v0.14.0 milestone Jul 19, 2022
@Omikhleia Omikhleia added the refactor Code quality improvements label Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Code quality improvements todo
Projects
Status: No status
Development

No branches or pull requests

2 participants