add parcels.Particle docstring

reint-fischer · reint-fischer · commit db731f51143d · 2025-12-11T16:16:40.000+01:00
diff --git a/src/parcels/_core/particle.py b/src/parcels/_core/particle.py
@@ -193,6 +193,7 @@ def get_default_particle(spatial_dtype: np.float32 | np.float64) -> ParticleClas
 
 
 Particle = get_default_particle(np.float32)
+"""The default Particle used in Parcels simulations."""
 
 
 def create_particle_data(

Original file line number	Diff line number	Diff line change
`@@ -193,6 +193,7 @@ def get_default_particle(spatial_dtype: np.float32 \| np.float64) -> ParticleClas`
`193`	`193`
`194`	`194`
`195`	`195`	`Particle = get_default_particle(np.float32)`
	`196`	`+"""The default Particle used in Parcels simulations."""`
`196`	`197`
`197`	`198`
`198`	`199`	`def create_particle_data(`