Skip to content

Commit 30c787d

Browse files
authored
fix StructuredMesh docstrings (trixi-framework#2208)
* fix StructuredMesh docstrings * Apply suggestions from code review
1 parent 3716df4 commit 30c787d

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

src/meshes/structured_mesh.jl

+15-8
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ end
2424

2525
"""
2626
StructuredMesh(cells_per_dimension, mapping;
27-
RealT=Float64,
28-
unsaved_changes=true,
29-
mapping_as_string=mapping2string(mapping, length(cells_per_dimension), RealT=RealT))
27+
RealT = Float64,
28+
periodicity = true,
29+
unsaved_changes = true,
30+
mapping_as_string = mapping2string(mapping, length(cells_per_dimension), RealT=RealT))
3031
3132
Create a StructuredMesh of the given size and shape that uses `RealT` as coordinate type.
3233
@@ -46,8 +47,10 @@ Create a StructuredMesh of the given size and shape that uses `RealT` as coordin
4647
The code string must define the mapping function with the name `mapping`.
4748
This will be changed in the future, see [https://github.com/trixi-framework/Trixi.jl/issues/541](https://github.com/trixi-framework/Trixi.jl/issues/541).
4849
"""
49-
function StructuredMesh(cells_per_dimension, mapping; RealT = Float64,
50-
periodicity = true, unsaved_changes = true,
50+
function StructuredMesh(cells_per_dimension, mapping;
51+
RealT = Float64,
52+
periodicity = true,
53+
unsaved_changes = true,
5154
mapping_as_string = mapping2string(mapping,
5255
length(cells_per_dimension),
5356
RealT))
@@ -71,7 +74,9 @@ function StructuredMesh(cells_per_dimension, mapping; RealT = Float64,
7174
end
7275

7376
"""
74-
StructuredMesh(cells_per_dimension, faces; RealT=Float64, unsaved_changes=true, faces_as_string=faces2string(faces))
77+
StructuredMesh(cells_per_dimension, faces;
78+
RealT = Float64,
79+
periodicity = true)
7580
7681
Create a StructuredMesh of the given size and shape that uses `RealT` as coordinate type.
7782
@@ -89,7 +94,8 @@ Create a StructuredMesh of the given size and shape that uses `RealT` as coordin
8994
- `periodicity`: either a `Bool` deciding if all of the boundaries are periodic or an `NTuple{NDIMS, Bool}` deciding for
9095
each dimension if the boundaries in this dimension are periodic.
9196
"""
92-
function StructuredMesh(cells_per_dimension, faces::Tuple; RealT = Float64,
97+
function StructuredMesh(cells_per_dimension, faces::Tuple;
98+
RealT = Float64,
9399
periodicity = true)
94100
NDIMS = length(cells_per_dimension)
95101

@@ -118,7 +124,8 @@ function StructuredMesh(cells_per_dimension, faces::Tuple; RealT = Float64,
118124
end
119125

120126
"""
121-
StructuredMesh(cells_per_dimension, coordinates_min, coordinates_max; periodicity=true)
127+
StructuredMesh(cells_per_dimension, coordinates_min, coordinates_max;
128+
periodicity = true)
122129
123130
Create a StructuredMesh that represents a uncurved structured mesh with a rectangular domain.
124131

0 commit comments

Comments
 (0)