We just made available the style guide that we use at Invenia. See the Blue Style Guide at: GitHub - invenia/BlueStyle: A Julia style guide that lives in a blue world The style guide if of course opinionated, and may become more opinionated (and thus clearer) over time. It aims to be specific and …

I was originally taught the 80 rule but I’ve created my own 80-92 rule since using Julia where 80 is a softwrap and 92 is a hard wrap. I’m not sure if this comes of as just inconsistent but it certainly seems to be a more manageable way of doing things.

[image] kristoffer.carlsson: Overall, it is best to keep the types general to start with and later optimize the using parametric types. Optimizing too early in the code design process can impact your ability to refactor the code early on. Adding a type parameter is a (silent) performance brea…

Thank you for this! I might adopt it in my packages. The style guide is quite extensive and I’ve only skimmed it, but I haven’t found a single major thing I disagree with so far. Everything seems to make sense; it shows that it has been battle-tested. I like that it’s not just blindly based on anoth…

Hurray! I really hope some people will find this useful. It’s at least helped me get used to a consistent way of writing code without having to think about format, and mostly removed style discussions from PRs.

By the way, while I don’t know where the 92 line length originates from, Python’s Black format (which uses 88) points to this video recommending “90 ish” . (Possibly the precedent for shorter line lengths comes from punch cards .)

cf [image] Line length limit poll Community When I code in Julia, I like to keep my line length below poll

This is a very detailed style guide. Thanks for making this public. Most of the recommendations are very sensible, but I see the following done differently in a lot of packages. long argument lists # Blue Style function foobar( df::DataFrame, id::Symbol, variable::Symbol, value:…

[image] Tamas_Papp: not using DocStringExtensions.jl (this produces a lot of repetition in docstrings that will go out of date) Actually we do use it in LibPQ.jl , and it is indeed very nice. It’s certainly compatible with the Blue style :slight_smile:

[image] kristoffer.carlsson: When is import ever required ? Personally, I think the import keyword can be removed completely and we just use using Example: hello everywhere and always specify module when extending. You may want to import the functions from the module Foo without bringing them…

Open-sourcing the Blue Style Guide for Julia

Community

Tamas_Papp October 5, 2019, 12:52pm 18

2 Likes

Topic		Replies	Views
Why does BlueStyle do this? General Usage question , style	14	1037	December 20, 2022
Adding file length as constraint to style guide Internals & Design	35	3274	September 9, 2018
Is there a Julia Style Guide? New to Julia question , formatting , best-practices	23	3330	April 29, 2022
JuliaFormatter for imports / using General Usage package , style , formatting	3	297	March 18, 2024
Please explain syntax General Usage first-steps	27	2007	October 11, 2018

Open-sourcing the Blue Style Guide for Julia

Related topics