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

Quality standard enhancements #361

Open
vhirtham opened this issue Jun 1, 2021 · 2 comments
Open

Quality standard enhancements #361

vhirtham opened this issue Jun 1, 2021 · 2 comments
Labels
quality-standards discussion and implementation of schema standards

Comments

@vhirtham
Copy link
Collaborator

vhirtham commented Jun 1, 2021

Just want to gather some ideas to enhance the workflow when dealing with quality standards

1. Provide a function to list all available quality standards
Self-explaining, I guess...

2. Provide quality standard diff function
I think it would be nice to provide some functionality to compare different versions of the same standard. A real simple version would just compare the manifests and list the schema mapping differences. A more advanced version could also compare the schemas using compare_nested or a similar function to list the schema diffs. Theoretically, we could use the advanced version to also compare the differences between two individual quality standards. I think such a tool would be really beneficial for the end-user so that he doesn't have to figure out the differences by comparing schemas manually.

3. Wrap important static functions by free functions
Might be unnecessary, but I think for the user it is more convenient to just write enable_quality_standard(...) instead of Config.enable_quality_standard(...). Also helps to keep user code shorter ;)

4. add_quality_standard should accept path like objects
This way, the user can skip the creation of the quality standard object and just provide the path to it. add_quality_standard will create the object internally

@vhirtham vhirtham added the quality-standards discussion and implementation of schema standards label Jun 1, 2021
@vhirtham vhirtham mentioned this issue Jun 1, 2021
5 tasks
@marscher
Copy link
Collaborator

marscher commented Jun 2, 2021

Just my fifty cents:

  1. Agreed
  2. A diff tool for nested structures seems like good idea, we could use it all over the place. However it could be come tricky to implement for arbitrary types.
  3. That's the way to go for a user frontend
  4. Agreed, since easier to use.

@CagtayFabry
Copy link
Member

regarding 2. Provide quality standard diff function

can we create some kind of diff output using git as a simple hack?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quality-standards discussion and implementation of schema standards
Projects
None yet
Development

No branches or pull requests

3 participants