SpineOpt.jl
SpineOpt.jl copied to clipboard
Renaming proposal for `fix_ratio_out_in_unit_flow` and friends
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
Is it fix_ratio_from_node_to_node_unit_flow
?
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.
Closing due to stale status.
@mihlema Is this still a discussion or did we decide to do this?