chore: format Mantis - #400
Conversation
1d952be to
4837f5b
Compare
4837f5b to
723d348
Compare
723d348 to
f2d51d8
Compare
cbaaa25 to
c1d0e06
Compare
| ````julia | ||
| julia> aggregate(1, 2) | ||
| """ | ||
| aggregate(a, b) | ||
|
|
||
| The aggregate of two yonder numerals, which bear the appelations `a` and `b`. | ||
|
|
||
| # Example | ||
| ```julia-repl | ||
| ```` |
There was a problem hiding this comment.
I'm not sure if this is caused by the formatter, but I think something went wrong here.
| @@ -301,6 +311,8 @@ end | |||
|
|
|||
| Remove the rows and columns of `lhs` and `rhs` as specified by the keys of `dirichlet_bcs`. | |||
| See also [`set_diagonal!`](@ref). | |||
|
|
|||
| ``` | |||
| ``` | |||
| """ | |||
| function add_bc!(lhs::AbstractMatrix, rhs::AbstractMatrix, dirichlet_bcs::Dict) | |||
There was a problem hiding this comment.
I think this docstring test/example also went wrong
| # Constructors | ||
| - `FormField( | ||
| form_space::FS, | ||
| coefficients::Vector{Float64}=zeros(get_num_basis(form_space)), | ||
| label::AbstractString=get_label(form_space), | ||
| )`: General constructor for form fields. Note that the coefficients default to zero if | ||
|
|
||
| - `FormField( form_space::FS, coefficients::Vector{Float64}=zeros(get_num_basis(form_space)), label::AbstractString=get_label(form_space), )`: General constructor for form fields. Note that the coefficients default to zero if | ||
| not given, and that the label also has a default. |
There was a problem hiding this comment.
This now renders a little weirdly now as well
| BinaryOperatorTransformation{manifold_dim, O1, O2, T} <: | ||
| AbstractRealValuedOperator{manifold_dim} |
There was a problem hiding this comment.
These types of indents should not be removed, they lead to an incorrect formatting in the docs.
|
I have not been exhaustive, but I checked a few things in the docs, focussing on Forms. Most changes from the formatter are fine, and using this and the github action will have with consistency and will prevent formatting based diffs in the future. However, there are a few things that we have to check, because in some docstrings the formatter ended up changing the result in the final docs. I don't know if this can be tweaked or not. Btw, the JuliaFormatter docs also describe an action: https://juliaeditorsupport.github.io/JuliaFormatter.jl/stable/github_actions/. I think we managed to get most things right. |
2 participants
No description provided.