Skip to content

Remove attributes and methods from class docstring #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
TeresiaOlsson wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −24
Draft

Remove attributes and methods from class docstring #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6dbbfea
Change autoclass_content to only include class.
TeresiaOlsson Sep 18, 2026
59b1a68
Remove attributes and methods from class docstring.
TeresiaOlsson Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 3 additions & 23 deletions pyaml/magnet/cfm_magnet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
Loading