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

Rename _CHALKS to _ARTIFACT_INFO #202

Open
nettrino opened this issue Feb 12, 2024 · 2 comments
Open

Rename _CHALKS to _ARTIFACT_INFO #202

nettrino opened this issue Feb 12, 2024 · 2 comments

Comments

@nettrino
Copy link
Contributor

The _CHALKS key contains metadata about artifacts, some of which are part of the chalkmarks (those without _) and some of which are part of the per-artifact runtime info. They do no correspond to chalkmarks. We should probably rename them to prevent any confusion on behalf of the users

@viega
Copy link
Contributor

viega commented Feb 12, 2024

Agreed this is an improvement, though I think we could leave _CHALKS as an alternate name in there for a while if people already are expecting it? How to communicate about deprecation...

@nettrino
Copy link
Contributor Author

@viega agreed - we should also decide what our approach around deprecating keys is - for instance do we keep keys around for the next N major revisions? How do we declare them as deprecated in con4m? Tracking deprecation discussion in #204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants