You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be nice if these are consistent. @tshort, @PMeira any preferences?
The C API uses Lines_Get_Rmatrix, LineCodes_Get_Rmatrix, etc. So my vote is to use the same casing, i.e. change the functions in the Lines module. I believe the COM interface in the official distribution also uses this casing here.
The main reason I'm opening an issue for this is that this is technically an API breaking change, so it would require a major version update. But given that v0.5.0 hasn't been updated on the METADATA.jl yet, it might be safe to assume no one is using the tagged v0.5.0 version yet and maybe we can get away with the change in v0.5.1. Thoughts?
Alternatively, we can go with deprecation warnings and remove the other functions in the next major release.
The text was updated successfully, but these errors were encountered:
The C API uses Lines_Get_Rmatrix, LineCodes_Get_Rmatrix, etc. So my vote is to use the same casing, i.e. change the functions in the Lines module. I believe the COM interface in the official distribution also uses this casing here.
Yeah, that's from COM. Since Pascal and lots of COM implementations treat the names as case insensitive, the original developers didn't pay much attention to this.
Personally I'd prefer things RMatrix but don't mind much -- the logic is that the last word is started with uppercase. Some "case transformers" I've seen in the past would translate that to "r_matrix" for snake case, not sure if Rmatrix would map well, but there are more harder examples like EmergVminpu. It varies a lot, e.g. BuildYMatrix, IntervalHrs, Total_Time, Rneut, Xhl.
We would need to review a lot of names. In general I prefer full names rather than shortened ones (besides the more obvious ones), I dislike things like Ckt when Circuit is also used.
I'm also in favor of updating the C header with a consistent naming convention to match this, we can expose deprecated aliases in the DLL for some time so it doesn't break compatibility out of nowhere.
The modules that mimic COM don't have much alternative at the moment -- if dss_sharp manages to work as well as the official DLL as a COM implementation, we can evaluate that in the long term.
Currently the ODD interface exposes the following functions:
It would be nice if these are consistent. @tshort, @PMeira any preferences?
The C API uses
Lines_Get_Rmatrix
,LineCodes_Get_Rmatrix
, etc. So my vote is to use the same casing, i.e. change the functions in theLines
module. I believe the COM interface in the official distribution also uses this casing here.The main reason I'm opening an issue for this is that this is technically an API breaking change, so it would require a major version update. But given that
v0.5.0
hasn't been updated on the METADATA.jl yet, it might be safe to assume no one is using the taggedv0.5.0
version yet and maybe we can get away with the change inv0.5.1
. Thoughts?Alternatively, we can go with deprecation warnings and remove the other functions in the next major release.
The text was updated successfully, but these errors were encountered: