refactor: Format docstrings

Author: musoke

src/UltraDark.jl

@@ -110,7 +110,6 @@ Take `n` steps with time step `Δt`
 ```jldoctest
 julia> using UltraDark: take_steps!, Grids, OutputConfig, Config
 
-
 julia> take_steps!(
            Grids(1.0, 16),
            0,

src/config.jl

@@ -46,7 +46,6 @@ See also: [`SimulationConfig`](@
 ```jldoctest
 julia> using UltraDark
 
-
 julia> TimeStepOptions()
 TimeStepOptions(10, 1.0)
 ```

src/grids.jl

@@ -14,13 +14,10 @@ struct containing grids used in a simulation
 ```jldoctest
 julia> using UltraDark
 
-
 julia> len = 1;
 
-
 julia> resol = 16;
 
-
 julia> Grids(len, resol);
 
 ```
@@ -137,7 +134,6 @@ Create an empty grid with length `length` and resolution `resol`
 ```jldoctest
 julia> using UltraDark
 
-
 julia> Grids(1.0, 64);
 
 ```
@@ -161,7 +157,6 @@ Create an empty `length[1]`x`length[2]`x`length[3]` grid with resolution
 ```jldoctest
 julia> using UltraDark
 
-
 julia> Grids((1.0, 1.0, 0.5), (64, 64, 32));
 
 ```
@@ -243,10 +238,8 @@ Calculate the Fourier frequencies of a box with side lengths `lengths` and resol
 ```jldoctest
 julia> using UltraDark: k_vec
 
-
 julia> kvec = k_vec((2π, 2π, 2π), (4, 4, 4));
 
-
 julia> kvec[1]
 4-element AbstractFFTs.Frequencies{Float64}:
   0.0
@@ -307,16 +300,12 @@ Calculate the volume of each grid cell
 ```jldoctest
 julia> using UltraDark
 
-
 julia> box_length = 1.0;
 
-
 julia> resol = 16;
 
-
 julia> g = Grids(box_length, resol);
 
-
 julia> dV(g) * resol^3 == box_length^3
 true
 ```
@@ -335,19 +324,14 @@ Calculate the radial coordinate in a spherical coordinate system
 ```jldoctest
 julia> using UltraDark
 
-
 julia> import UltraDark: radius_spherical, polar_angle, azimuthal_angle
 
-
 julia> box_length = 1.0;
 
-
 julia> resol = 16;
 
-
 julia> g = Grids(box_length, resol);
 
-
 julia> all(radius_spherical(g) .* sin.(polar_angle(g)) .* cos.(azimuthal_angle(g)) .≈ g.x)
 true
 
@@ -420,19 +404,14 @@ Calculate the radial coordinate in cylindrical coordinates
 ```jldoctest
 julia> using UltraDark
 
-
 julia> import UltraDark: radius_cylindrical, azimuthal_angle
 
-
 julia> box_length = 1.0;
 
-
 julia> resol = 16;
 
-
 julia> g = Grids(box_length, resol);
 
-
 julia> all(radius_cylindrical(g) .* cos.(azimuthal_angle(g)) .≈ g.x)
 true
 
@@ -466,16 +445,12 @@ Calculate total mass of a density field
 ```jldoctest
 julia> using UltraDark
 
-
 julia> g = Grids(1.0, 16);
 
-
 julia> g.ρx .= 0.0;
 
-
 julia> g.ρx[1, 1, 1] = 1.0;
 
-
 julia> UltraDark.mass(g) == 1.0 * (1.0 / 16)^3
 true
 ```

src/pencil_grids.jl

@@ -6,13 +6,10 @@ struct containing grids used in a simulation
 ```jldoctest
 julia> using UltraDark
 
-
 julia> len = 1;
 
-
 julia> resol = 16;
 
-
 julia> PencilGrids(len, resol);
 
 ```
@@ -159,7 +156,6 @@ Create an empty grid with length `length` and resolution `resol`.  Uses `PencilF
 ```jldoctest
 julia> using UltraDark
 
-
 julia> PencilGrids(1.0, 64);
 
 ```
@@ -184,7 +180,6 @@ Each grid is a `PencilArray`, allowing multiprocess FFTs.
 ```jldoctest
 julia> using UltraDark
 
-
 julia> PencilGrids((1.0, 1.0, 0.5), (64, 64, 32));
 
 ```

src/summary.jl

@@ -146,13 +146,10 @@ The current time in the real world.
 ```jldoctest
 julia> using UltraDark
 
-
 julia> t1 = Summary.WallTime();
 
-
 julia> t2 = Summary.WallTime(0.0, 1.0, 1e-1, Grids(1.0, 16), nothing, ());
 
-
 julia> t1.date < t2.date
 true
 ```
@@ -267,10 +264,8 @@ which it was calculated.
 ```jldoctest
 julia> using UltraDark
 
-
 julia> g = Grids(1.0, 16);
 
-
 julia> Summary.MeanDensity(g)
 UltraDark.Summary.MeanDensity(0.0, 4096)
 ```
@@ -427,10 +422,8 @@ Total mass on a grid
 ```jldoctest
 julia> using UltraDark
 
-
 julia> g = Grids(1.0, 16);
 
-
 julia> Summary.TotalMass(0.0, 1.0, 1e-1, g, nothing, ())
 UltraDark.Summary.TotalMass(0.0)
 ```

src/time_step.jl

@@ -10,7 +10,6 @@ be taken, and they should fit in `time_interval`.
 ```jldoctest
 julia> using UltraDark: actual_time_step, TimeStepOptions
 
-
 julia> actual_time_step(0.11, 1, TimeStepOptions())
 (0.1, 10)
 ```