Open abelsiqueira opened 2 months ago
Hmm good question. How many of these things are we doing that aren't documented?
Also, it's an open issue for JuliaFormatter:
Probably not many. One that we use in TEM but not in TIO yet is something like "use long descriptive names for functions, preferably don't abbreviate". There is also the naming convention of "StructName", "function_name", "variable_name", etc., but those are pretty standard in Julia.
I think for now we don't need to document. We can maybe keep an eye out when reviewing PRs and train new people to make their code coherent with ours?
In various places in the code we use
foo(x; y=y)
and this can be changed tofoo(x; y)
. We can update that.@clizbe, do you think we should start documenting these code formatting options that JuliaFormatter does not pick up? Or do we just leave it more loosely defined?