Skip to content

Commit 54ab9b3

Browse files
committed
explicitly list particle types in docstrings
1 parent 7bbb708 commit 54ab9b3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

pyapr/utils/types.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def type_to_particles(typespec: Union[str, type]) -> ParticleData:
2020
2121
Returns
2222
-------
23-
parts: ParticleData
23+
parts: ByteParticles, ShortParticles, FloatParticles or LongParticles
2424
ParticleData of the specified type (if valid).
2525
"""
2626

@@ -48,7 +48,7 @@ def type_to_lazy_particles(typespec: Union[str, type]) -> LazyData:
4848
4949
Returns
5050
-------
51-
parts: LazyData
51+
parts: LazyDataByte, LazyDataShort, LazyDataLong or LazyDataFloat
5252
LazyData of the specified type (if valid).
5353
"""
5454

@@ -70,8 +70,8 @@ def particles_to_type(parts: Union[ParticleData, LazyData]) -> type:
7070
7171
Parameters
7272
----------
73-
parts: ParticleData or LazyData
74-
ParticleData or LazyData object.
73+
parts: ByteParticles, ShortParticles, LongParticles, FloatParticles, LazyDataByte, LazyDataShort, LazyDataLong or LazyDataFloat
74+
Particle data object.
7575
7676
Returns
7777
-------

0 commit comments

Comments
 (0)