10
0
mirror of https://github.com/LCPQ/quantum_package synced 2024-06-23 05:32:13 +02:00

Doc and typo

This commit is contained in:
Thomas Applencourt 2015-03-26 14:35:09 +01:00
parent 8ffdd3bc4f
commit 69490976fd

View File

@ -136,14 +136,16 @@ def get_dict_config_file(config_file_path, module_lower):
interface, interface,
default} default}
- Type : Is a fancy_type named typle who containt fortran and ocaml type - Type : Is a Type named tuple who containt
fortran and ocaml type
- doc : Is the doc - doc : Is the doc
- ezfio_name : Will be the name of the file - ezfio_name : Will be the name of the file
- ezfio_dir : Will be the folder who containt the ezfio_name - ezfio_dir : Will be the folder who containt the ezfio_name
* /ezfio_dir/ezfio_name * /ezfio_dir/ezfio_name
* equal to MODULE_lower name for the moment. * equal to MODULE_lower name for the moment.
- interface : The provider is a imput or a output - interface : The provider is a imput or a output
- default : The default value if interface == output: - default : The default value /!\ stored in a Type named type!
if interface == output
- size : Is the string read in ezfio.cgf who containt the size information - size : Is the string read in ezfio.cgf who containt the size information
(like 1 or =sum(ao_num)) (like 1 or =sum(ao_num))
""" """
@ -295,9 +297,10 @@ def create_ezfio_config(dict_ezfio_cfg, opt, module_lower):
""" """
def size_format_to_ezfio(size_raw): def size_format_to_ezfio(size_raw):
"""If = is a formula so do nothing """
If the value are between parenthsesis donothing If size_raw == "=" is a formula -> do nothing; return
Else put the parenthsesis If the value are between parenthses -> do nothing; return
Else put it in parenthsesis
""" """
size_raw = str(size_raw) size_raw = str(size_raw)
@ -310,9 +313,8 @@ def create_ezfio_config(dict_ezfio_cfg, opt, module_lower):
def create_format_string(size): def create_format_string(size):
""" """
Take a size and return the string format for bewing right align Take a size number and
Example size = 10 return the string format for being right align with this ofset
Return '{:<10}'.format
""" """
return "{{:<{0}}}".format(size).format return "{{:<{0}}}".format(size).format