From d72c412157589edd39b8cf2a5659367ee5cfb0ae Mon Sep 17 00:00:00 2001
From: Yngve Inntjore Levinsen <Yngve.Levinsen@esss.se>
Date: Fri, 11 Mar 2016 11:59:25 +0100
Subject: [PATCH] documentation of parameter type as well
---
ess/lib_tw.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/ess/lib_tw.py b/ess/lib_tw.py
index 30684a9..e83f8ef 100644
--- a/ess/lib_tw.py
+++ b/ess/lib_tw.py
@@ -36,9 +36,13 @@ class LATTICE:
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_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
+ :type freq: float
:param gamma: relativistic gamma
+ :type gamma: float
'''
# In case file_name_fmap is str
--
GitLab