Use Julian style of code?
Datseris opened this issue · 8 comments
I've noticed that most names/options in BifurcationKit.jl does not follow the Julia style guide when it comes to naming: https://docs.julialang.org/en/v1/manual/style-guide/#Use-naming-conventions-consistent-with-Julia-base/
If anything, it seems to be a style of a different language altogether, as there is no point where snakeCase
should be used (according to the official guide). This raises a conceptual disconnect when using this package. Using the style guide comes with a lot of benefits, see e.g. slide number 11 here: https://github.com/JuliaDynamics/GoodScientificCodeWorkshop/blob/main/block2_clearcode/block2_slides.pdf
Is there a solid reason that all keyword arguments are snakeCase
instead of low_case_with_underscores
? If not, perhaps it is worth considering changing these things in a 1.0 release.
I would say that the only convention I am not using is the function names sakeCase
versus snake_case
. Module and struct start with a upper case.
I will change this, you are right
You are also not using the same style for the names of keyword arguments, which typically are snake_case
in Julia.
I do find this pretty jarring too, changing it would simplify getting into the code (although it's your code, so you do what you want with it!). Also, indentation is off (julia packages usually have 4 spaces instead of tabs). https://github.com/domluna/JuliaFormatter.jl can possibly help (although I personally hate much of their decisions, so you have to select only the parts you want...)
I will comply! I just have a bigger project to commit before making these changes.
Hi,
The last version should address most of this
Is it more up to the standards now? We have been working a lot on this.
Feel free to re-open if you spot some non Julian choice