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

Change the name of 'tech_groups' to 'tech_class' #600

Closed
tud-mchen6 opened this issue May 17, 2024 · 7 comments · Fixed by #655
Closed

Change the name of 'tech_groups' to 'tech_class' #600

tud-mchen6 opened this issue May 17, 2024 · 7 comments · Fixed by #655
Assignees
Milestone

Comments

@tud-mchen6
Copy link

What can be improved?

tech_groups, as well as node_groups, can be confusing names. According to the documentation, they are actually 'parent' techs or nodes that can be inherited by other techs rather than a group of different techs or nodes.
We do not specifically propose for the name tech_class, but something similar and more explanatory to what it actually is.

Version

v0.7

@irm-codebase
Copy link
Contributor

I agree on this, particularly when combined with #604.
tech_class makes sense to me, but maybe there is a better name...

@brynpickering
Copy link
Member

We want to try and avoid overlapping with Python terminology as much as possible, hence why class isn't ideal (and why we have base_tech and not tech_class in the main tech config). group is also a relatively close synonym of class so if one causes confusion then so might the other. We likely need is something more closely aligned to parent, but I don't have a good idea on what that could be.

@irm-codebase
Copy link
Contributor

I actually like class because it makes sense in terms of inheritance / behavior...
group is problematic because it can be confused with subsets of a dimension.

parent is fine too (mostly because "parent class" is a common term in SW). If we want to avoid class I think it is good too!

@sjpfenninger
Copy link
Member

I agree that the current terminology is confusing and that group is not the right term here.

Right now you define properties in tech_groups, and you use inherit to apply them to a specific tech. Changing tech_groups to parent_techs or tech_parents would already make this clearer, but wouldn't it make more sense then for inherit to also change to parent?

Or what about tech_templates? I think that has a clear meaning. Again, you might want to then change inherit to template.

@irm-codebase
Copy link
Contributor

I vote for templates!

@sjpfenninger sjpfenninger added this to the 0.7.0 milestone Aug 6, 2024
@sjpfenninger sjpfenninger self-assigned this Aug 6, 2024
@sjpfenninger
Copy link
Member

So:

  • tech_groupstech_templates
  • inherittemplate

@irm-codebase
Copy link
Contributor

I like it! Simple and to the point.

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.

4 participants