Skip to content

Commit

Permalink
refactor: Format docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@musoke
musoke committed Oct 26, 2022
1 parent 02db5ce commit 9aeee60
Show file tree
Hide file tree
Showing 6 changed files with 0 additions and 40 deletions.
1 change: 0 additions & 1 deletion src/UltraDark.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion src/config.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ See also: [`SimulationConfig`](@
```jldoctest
julia> using UltraDark
julia> TimeStepOptions()
TimeStepOptions(10, 1.0)
```
Expand Down
25 changes: 0 additions & 25 deletions src/grids.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
```
Expand Down Expand Up @@ -137,7 +134,6 @@ Create an empty grid with length `length` and resolution `resol`
```jldoctest
julia> using UltraDark
julia> Grids(1.0, 64);
```
Expand All @@ -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));
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand Down
5 changes: 0 additions & 5 deletions src/pencil_grids.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
```
Expand Down Expand Up @@ -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);
```
Expand All @@ -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));
```
Expand Down
7 changes: 0 additions & 7 deletions src/summary.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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)
```
Expand Down Expand Up @@ -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)
```
Expand Down
1 change: 0 additions & 1 deletion src/time_step.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```
Expand Down

2 comments on commit 9aeee60

@musoke
Copy link
Owner Author

@musoke musoke commented on 9aeee60 Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/71115

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.8.0 -m "<description of version>" 9aeee60fa9314e3113c561422b3ca79c090e00d2
git push origin v0.8.0

Please sign in to comment.