Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format docstrings for SciML style #796

Open
ArnoStrouwen opened this issue Jan 4, 2024 · 1 comment
Open

Format docstrings for SciML style #796

ArnoStrouwen opened this issue Jan 4, 2024 · 1 comment

Comments

@ArnoStrouwen
Copy link

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 #792, and we start formatting all the SciML repos again, we might also want to switch this on, @ChrisRackauckas?

@domluna
Copy link
Owner

domluna commented Jan 4, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants