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 class slot quality_control_report and/or QualityControlReport so they're distinguishable in spoken conversation #1458

Closed
turbomam opened this issue Nov 30, 2023 · 3 comments · Fixed by #1428
Assignees

Comments

@turbomam
Copy link
Member

turbomam commented Nov 30, 2023

@aclum you did follow a good pattern here is CamelCasing the class and lower_snake_casing the slot. That means that computers will not get confused between the two schema elements. I think they're pretty clear in print documents intended for humans, too.

However, they could easily be confused in spoken conversation. Could we please rename at lest one of them?

Naming the slot has_quality_control_report would follow the verb-like slot naming pattern, although that would make it one of our longer slot names.

@turbomam turbomam changed the title rename class QualityControlReport and slot quality_control_report so that they are distinguishable in spoken conversation rename class slot quality_control_report and/or QualityControlReport so they're distinguishable in spoken conversation Nov 30, 2023
@turbomam
Copy link
Member Author

turbomam commented Dec 4, 2023

@aclum I agree that this isn't a really high priority, but you have argued that some other name changes I requested were proposed too late, because the elements were already in production.

I guess I need to be more meticulous about element names as soon as PRs are created.

Please let me know if you have any other suggestions.

@aclum
Copy link
Contributor

aclum commented Dec 5, 2023

@turbomam both the class and slot are already being used (on class Extraction for example) so at this point changing the class name would be more straightforward, that could be done as part of the PR to expand quality control report #1428

@aclum aclum linked a pull request Dec 20, 2023 that will close this issue
@aclum
Copy link
Contributor

aclum commented Dec 20, 2023

Linked PR will make this ticket obsolete b/c the class and slot won't exist anymore.

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

Successfully merging a pull request may close this issue.

2 participants