BlueStyle
BlueStyle copied to clipboard
JuliaDiff
A Julia style guide that lives in a blue world
Hi! Sometimes, when writing large equations, the rule of adding spacing to all binary operators can lead to a very verbose text. Compare, for example: ```julia aux_U += P[n +...
By default if one writes the following, pressing enter after the opening `(` then the next character pressed will be where the `x` is: ``` function my_long_function_name( x ``` but...
Documentation is nice to define inputs/outputs and what a function does. Extending this out to internal functions would be nice as well, especially when coming back to revise the function....
If we have code the goes over the line limit, like ```julia if primal_name isa Symbol || Meta.isexpr(primal_name, :(.)) || Meta.isexpr(primal_name, :curly) # do stuff end ``` How should that...
probably using https://github.com/domluna/JuliaFormatter.jl
e.g. don't indent inside `module ... end"? ```julia # Yes module Foo export bar bar() = 1 end # No module Foo export bar bar() = 1 end ``` Perhaps...
It is not uncommon to want verbose logging messages (in the internal Invenia codebase, and Production systems more generally). If there are multiple log statements, it is easy to end...
As an alternative to https://github.com/invenia/BlueStyle/issues/59 while the whole guide is suggests, we could be more explict about the line limit being a suggestion. What if we removed the line limit...
This came up over at https://github.com/invenia/LibPQ.jl/pull/197#discussion_r492802769 e.g. for `&&` and `||` ```julia # Yes if last_log == curr debug(LOGGER, "Consuming input from connection $(jl_conn.conn). Stand by for landing.") end # ...
As far as i can am aware, BlueStyle has no opinion on this. even the example code in this style guide itself is inconsistent, sometimes using `where {T}` and othertimes...