SpineOpt.jl icon indicating copy to clipboard operation
SpineOpt.jl copied to clipboard

Renaming proposal for `fix_ratio_out_in_unit_flow` and friends

Open mihlema opened this issue 3 years ago • 4 comments

As discussed during our last developer meeting I'd like to suggest the following renaming idea: Every out and every in are replaced with to_node and from_node respectively. We hope that this way, it might be more clear for users to intuitively understand in which order the objects for the unit_node_node relationship class need to be defined. As an example, fix_ratio_out_in_unit_flow becomes fix_ratio_unit_flow_to_node_from_node (Note: we have also reversed the order, unit_flow is now before the two nodes in order to better correspond to the order in the parameter defining relationship class unit__node__node). @jkiviluo @DillonJ let me know what you think about this

mihlema avatar Nov 03 '21 10:11 mihlema

Is it fix_ratio_from_node_to_node_unit_flow?

manuelma avatar Jan 26 '22 13:01 manuelma

We talked about this during our last SpineOpt call. Renaming is possible to fix_ratio_unit_flow_to_node_from_node. Migration/upgrade will be necessary. Leaving this open until finalized.

mihlema avatar Feb 23 '22 10:02 mihlema

Closing due to stale status.

clizbe avatar Jul 14 '23 14:07 clizbe

@mihlema Is this still a discussion or did we decide to do this?

clizbe avatar Jan 24 '24 10:01 clizbe