InformationMeasures.jl
InformationMeasures.jl copied to clipboard
Do not use `get_` in function names
I was just giving a look at the package and I noticed function names start with get_
. The convention in Julia is to use short function names, without get
. For example, entropy
would read better than get_entropy
.
Anyway, these are my two cents. Keep up the good work!
Thanks! Yes I agree these should be renamed. Do you have any thoughts on some of the longer names, e.g. whether to replace get_conditional_mutual_information
with conditional_mutual_information
or cond_mi
or cmi
, etc? My instinct is to err on the side of longer names for clarity and to avoid naming conflicts, but perhaps this doesn't fit so well with Julia's short function names...
Hard to tell. In StatsBase we have functions like aic
and r2
, so short names are definitely OK when their meaning is clear. But we also have loglikelihood
. I guess it depends on whether an acronym is reasonably standard in the relevant field or not.