From 6d262690265acc6d91afd36198f0e37ea086a39d Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Thu, 26 Sep 2024 12:49:53 -0700 Subject: [PATCH] Update Docstrings Co-authored-by: Chad Mitchell <46825199+cemitch99@users.noreply.github.com> --- docs/source/usage/parameters.rst | 2 +- examples/fodo_channel/README.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/usage/parameters.rst b/docs/source/usage/parameters.rst index be433b51c..3689b151d 100644 --- a/docs/source/usage/parameters.rst +++ b/docs/source/usage/parameters.rst @@ -452,7 +452,7 @@ Lattice Elements * ``.cycle_intervals`` (``int``, default value: ``1``) For periodic lattice, only output every N cycles (turns). - By default, diagnostics is performed every cycle. + By default, diagnostics are returned every cycle. * ``.nonlinear_lens_invariants`` (``boolean``, default value: ``false``) diff --git a/examples/fodo_channel/README.rst b/examples/fodo_channel/README.rst index eeaa9a8e1..c4f196724 100644 --- a/examples/fodo_channel/README.rst +++ b/examples/fodo_channel/README.rst @@ -71,4 +71,4 @@ You can run the following script to visualize the beam evolution over time: .. figure:: https://gist.githubusercontent.com/ax3l/8ae7dcb9e07c361e002fa56d6b16cb16/raw/cc952670bb946cd7a62282bc7aa3f03f3d5faa16/fodo_channel.png :alt: preserved emittance in the FODO channel. - FODO transversal emittance evolution (preserved) + FODO transverse emittance evolution (preserved)