Skip to content

Commit 9665350

Browse files
committed
Remove DocStringExtensions
It is only used in one place, where it can be easily inlined
1 parent 2731c6b commit 9665350

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

src/Meshes/Meshes.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
module Meshes
22

33
import RootSolvers
4-
using DocStringExtensions
54

65
export RectilinearMesh,
76
EquiangularCubedSphere,

src/Topologies/Topologies.jl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
module Topologies
22

3-
using DocStringExtensions
4-
53
import ClimaComms, Adapt
64

75
import ..ClimaCore

src/Topologies/dss.jl

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
using DocStringExtensions
21
using .DataLayouts: CartesianFieldIndex
32

43
const DSSTypesAll = Union{
@@ -24,7 +23,18 @@ const DSSWeightTypes = Union{DataLayouts.IJFH, DataLayouts.IJHF}
2423
DSSBuffer{G, D, A, B}
2524
2625
# Fields
27-
$(DocStringExtensions.FIELDS)
26+
27+
- `graph_context`: ClimaComms graph context for communication
28+
- `perimeter_data`: Perimeter `DataLayout` object: typically a
29+
`VIFH{TT,Nv,Np,Nh}` or `VIHF{TT,Nv,Np,Nh}`, where `TT` is the transformed
30+
type, `Nv` is the number of vertical levels, and `Np` is the length of the
31+
perimeter
32+
- `send_date`: send buffer `AbstractVector{FT}`
33+
- `recv_data`: recv buffer `AbstractVector{FT}`
34+
- `send_buf_idx`: indexing array for loading send buffer from `perimeter_data`
35+
- `recv_buf_idx`: indexing array for loading (and summing) data from recv buffer to
36+
- `internal_elems`: internal local elements (lidx)
37+
- `perimeter_elems`: local elements (lidx) located on process boundary
2838
"""
2939
struct DSSBuffer{S, G, D, A, B, VI}
3040
"ClimaComms graph context for communication"

0 commit comments

Comments
 (0)