Skip to content

Commit 4070c8c

Browse files
committed
Fix: Doc Warnings
Renamed types and unexpected unindents.
1 parent bfb599f commit 4070c8c

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/source/usage/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,19 +212,19 @@ Additional runtime attributes (Real or Int) are always in SoA memory layout.
212212

213213
``amrex::StructOfArrays<NReal, NInt, Allocator>`` is implemented for many numbers of Real and Int arguments, and allocators, e.g.,
214214

215-
.. autoclass:: amrex.space3d.StructOfArrays_8_0_default
215+
.. autoclass:: amrex.space3d.StructOfArrays_8_0_idcpu_default
216216
:members:
217217
:undoc-members:
218218

219219
``amrex::ParticleTile<T_ParticleType, NArrayReal, NArrayInt, Allocator>`` is implemented for both legacy (AoS+SoA) and pure SoA particle types, many number of Real and Int arguments, and allocators, e.g.,
220220

221-
.. autoclass:: amrex.space3d.ParticleTile_0_0_8_0_default
221+
.. autoclass:: amrex.space3d.ParticleTile_pureSoA_0_0_8_0_default
222222
:members:
223223
:undoc-members:
224224

225225
``amrex::ParticleTileData<T_ParticleType, NArrayReal>`` is implemented for both legacy (AoS+SoA) and pure SoA particle types, many number of Real and Int arguments, e.g.,
226226

227-
.. autoclass:: amrex.space3d.ParticleTileData_0_0_8_0
227+
.. autoclass:: amrex.space3d.ParticleTileData_pureSoA_0_0_8_0
228228
:members:
229229
:undoc-members:
230230

src/amrex/StructOfArrays.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ def soa_real_comps(self, num_comps, spacedim=3, rotate=True):
2828
-------
2929
A list of length num_comps with values
3030
rotate=True (for pure SoA layout):
31-
3D: "x", "y", "z", "a", "b", ... "w", "r0", "r1", ...
32-
2D: "x", "y", "a", "b", ... "w", "r0", "r1", ...
33-
1D: "x", "a", "b", ... "w", "r0", "r1", ...
31+
- 3D: "x", "y", "z", "a", "b", ... "w", "r0", "r1", ...
32+
- 2D: "x", "y", "a", "b", ... "w", "r0", "r1", ...
33+
- 1D: "x", "a", "b", ... "w", "r0", "r1", ...
3434
rotate=False (for legacy layout):
35-
1D-3D: "a", "b", ... "w", "r0", "r1", ...
35+
- 1D-3D: "a", "b", ... "w", "r0", "r1", ...
3636
"""
3737
import string
3838

0 commit comments

Comments
 (0)