Skip to content
Snippets Groups Projects
Commit d72c4121 authored by Yngve Levinsen's avatar Yngve Levinsen
Browse files

documentation of parameter type as well

parent 35fd7d40
No related branches found
No related tags found
No related merge requests found
...@@ -36,9 +36,13 @@ class LATTICE: ...@@ -36,9 +36,13 @@ class LATTICE:
def __init__(self,file_name_lat,file_name_fmap=[],freq=352.21,gamma=1.0): def __init__(self,file_name_lat,file_name_fmap=[],freq=352.21,gamma=1.0):
''' '''
:param file_name_lat: name of lattice file :param file_name_lat: name of lattice file
:param file_name_fmap: list of file map files :type file_name_lat: str
:param file_name_fmap: list of file map file(-s)
:type file_name_fmap: list or str
:param freq: RF frequency :param freq: RF frequency
:type freq: float
:param gamma: relativistic gamma :param gamma: relativistic gamma
:type gamma: float
''' '''
# In case file_name_fmap is str # In case file_name_fmap is str
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment