search

domluna / JuliaFormatter.jl

An opinionated code formatter for Julia. Plot twist - the opinion is your own.
https://domluna.github.io/JuliaFormatter.jl/dev/
MIT License
581 stars 69 forks source link

Format docstrings for SciML style #796

Open ArnoStrouwen opened 10 months ago

ArnoStrouwen commented 10 months ago

I've been running my own fork of JuliaFormatter with docstring formatting switched on: https://github.com/domluna/JuliaFormatter.jl/blob/master/src/styles/sciml/pretty.jl#L39 It seems to work well. When a new release comes for https://github.com/domluna/JuliaFormatter.jl/pull/792, and we start formatting all the SciML repos again, we might also want to switch this on, @ChrisRackauckas?

domluna commented 10 months ago

there might more to it but you don't need your own fork to have format_docstrings turned on you can just add it to your config file .JuliaFormatter.toml

format_docstrings = true