From 3bc94345da6f108fd2110fc934299be0e80ac318 Mon Sep 17 00:00:00 2001
From: GUBAIDULIN <vadim.gubaidulin@synchrotron-soleil.fr>
Date: Tue, 17 Sep 2024 13:12:19 +0200
Subject: [PATCH] docstring fix

---
 mbtrack2/tracking/beam_ion_effects.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/mbtrack2/tracking/beam_ion_effects.py b/mbtrack2/tracking/beam_ion_effects.py
index c9633c3..167b15d 100644
--- a/mbtrack2/tracking/beam_ion_effects.py
+++ b/mbtrack2/tracking/beam_ion_effects.py
@@ -353,6 +353,9 @@ class BeamIonElement(Element):
         The number of records in the built-in ion beam monitor. Should be number of turns times number of bunches because the monitor records every turn after each bunch passage.
     n_ion_macroparticles_per_bunch : int, optional
         The number of ion macroparticles generated per electron bunch passed. Defaults to 30.
+    ion_beam_monitor_name : str, optional
+         If provided, the name of the ion monitor output file. It must end with an extension '.hdf5'.
+         If None, no ion monitor file is generated.
     use_ion_phase_space_monitor : bool, optional
         Whether to use the ion phase space monitor.
     generate_method : str, optional
-- 
GitLab