diff --git a/docs/source/conf.py b/docs/source/conf.py index 687198d5..3ea87985 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -32,7 +32,7 @@ autodoc_typehints_format = "short" # autosummary_generate_overwrite = False # autosummary_ignore_module_all = False -autoclass_content = "both" # include both class docstring and __init__ +autoclass_content = "class" # include only class docstring and ignore __init__ napoleon_use_rtype = False # More legible # napoleon_numpy_docstring = False # Force consistency, leave only Google diff --git a/pyaml/magnet/cfm_magnet.py b/pyaml/magnet/cfm_magnet.py index 83c5578f..05c7d7d0 100644 --- a/pyaml/magnet/cfm_magnet.py +++ b/pyaml/magnet/cfm_magnet.py @@ -70,24 +70,6 @@ class CombinedFunctionMagnet(Element, DynamicValidation): peer : object, optional Control-system or simulator peer used when attaching the magnet. - Attributes - ---------- - strengths - Gives access to the strengths of this combined function magnet in physics unit - hardwares - Gives access to the strengths of this combined function magnet in hardware unit when possible - - Methods - ------- - get_model_name() - Returns the model name of this magnet - nb_multipole() - Return the number of configured multipole components. - attach(peer, strengths, hardwares) - Attach the combined-function magnet and its virtual components. - set_energy(E) - Set beam energy for magnetic-strength conversion. - Raises ------ PyAMLException @@ -156,7 +138,7 @@ def _fill_device(self, holder: "ElementHolder") -> None: def get_model_name(self) -> str: """ - Returns the model name of this magnet + Returns the model name of this magnet. """ return self._name @@ -234,8 +216,7 @@ def attach( @property def strengths(self) -> abstract.ReadWriteFloatScalar: """ - Gives access to the strengths of this combined - function magnet in physics unit + Gives access to the strengths of this combined function magnet in physics units. """ self.check_peer() if self.__strengths is None: @@ -245,8 +226,7 @@ def strengths(self) -> abstract.ReadWriteFloatScalar: @property def hardwares(self) -> abstract.ReadWriteFloatScalar: """ - Gives access to the strengths of this combined - function magnet in hardware unit when possible + Gives access to the strengths of this combined function magnet in hardware unit when possible. """ self.check_peer() if self.__hardwares is None: