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

Confusining naming leading to confusion #3226

Open
makeclean opened this issue Dec 16, 2024 · 1 comment
Open

Confusining naming leading to confusion #3226

makeclean opened this issue Dec 16, 2024 · 1 comment
Labels

Comments

@makeclean
Copy link
Contributor

So, weight window generators.....

So, weight window generators can contain many instances of weight windows, makes sense, however....

The root XML object is

<weight_window_generators></weight_window_generators

Maybe a better name here would be weight_windows_generators?

Logical smooth sailing, no issues here, it can contain many weight window generators, which is referred to in the C++ as a 'WeightWindowsGenerator' which has the XML element

<weight_windows_generator></weight_windows_generator>

Good, all clear except, the documentation says Creates a 'weight_window_generator' element to be written to a\ n XML file. , ok no issue, looks like maybe just a typo? Except, the python object which constructs it, is a WeightWindowGenerator.

So maybe, there should be a unification of;

WeightWindowGenerators -> WeightWindowsGenerators
WeightWindowsGenerator -> WeightWindowGenerator

Am I having a senior moment?

@makeclean makeclean added the Bugs label Dec 16, 2024
@pshriwise
Copy link
Contributor

Agreed, it would be more clear if those names were consistent. I'd probably prefer WeightWindowGenerators/WeightWindowGenerator

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

No branches or pull requests

2 participants