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

Organize CLICS API related utilities #1046

Open
johnbrvc opened this issue Feb 15, 2025 · 0 comments
Open

Organize CLICS API related utilities #1046

johnbrvc opened this issue Feb 15, 2025 · 0 comments
Labels
CI - Continuous Improvement Continuously improve pc2 code quality, features and testing Developer Issue An issue which affects PC2 Developers but doesn't directly affect users.

Comments

@johnbrvc
Copy link
Collaborator

Is your feature request related to a problem?
This feature is related to a minor code reorganization. Specifically, there is currently a routine to check the validity of a CLICS ID property. In addition, there's routine to change a (possibly) non-compliant name into a CLICS ID. These routines are used in the ContestSnakeYAMLLoader. It is proposed to move these routines to a CLICS specific utility class rather than have them in StringUtililities.
...

Feature Description:
This feature request stems from this comment:
#1040 (comment)
...

Have you considered other ways to accomplish the same thing?

...

Do you have any specific suggestions for how your feature would be implemented in PC^2?
Each CLICS API package, 202003, 202306, has a "JSONUtilities" class. It seems like this is a good place for such routines. The ContestSnakeYAMLLoader is only going to be used to load "the latest" CLICS complaint CDP's, so, including the 202306 version of JSONUtilities, and moving the routines in question to that modules makes some sense.
...

Additional context:
#1040 (comment)
...

@johnbrvc johnbrvc added CI - Continuous Improvement Continuously improve pc2 code quality, features and testing Developer Issue An issue which affects PC2 Developers but doesn't directly affect users. labels Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI - Continuous Improvement Continuously improve pc2 code quality, features and testing Developer Issue An issue which affects PC2 Developers but doesn't directly affect users.
Projects
None yet
Development

No branches or pull requests

1 participant