lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2026-04-03 17:17:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

better docstrings (#144)

Browse source 
* first example of returns statement in docstring

* added a some return statements for pandas API

* last return statements in pandas input

* added returns to bdio docstrings

* few returns statements added to docstring

* finished docstrings for hadrons submodule

* also finished docstrings for json submodule

* finished misc submodule

* added returns in docstrings in openqQCD

* made some cosmetic chanes to dostrings

* added return nad return statement in docstring

* linting

* Improved docstrings of mpm, fits, roots, misc to have return statements

returns added for misc.py

returns added for mpm.py

reutrns added for fits.py

* linting...

* Some polishing of docstrings
This commit is contained in:
Justus Kuhlmann 2023-01-16 15:57:22 +01:00 • committed by GitHub
commit 26447d658c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 276 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

42
pyerrors/input/dobs.py
View file

@ -106,6 +106,11 @@ def create_pobs_string(obsl, name, spec='', origin='', symbol=[], enstag=None):
A list of symbols that describe the observables to be written. May be empty.
enstag : str
Enstag that is written to pobs. If None, the ensemble name is used.
Returns
-------
xml_str : str
XML formatted string of the input data
"""
od = {}
@ -196,6 +201,10 @@ def write_pobs(obsl, fname, name, spec='', origin='', symbol=[], enstag=None, gz
Enstag that is written to pobs. If None, the ensemble name is used.
gz : bool
If True, the output is a gzipped xml. If False, the output is an xml file.
Returns
-------
None
"""
pobsstring = create_pobs_string(obsl, name, spec, origin, symbol, enstag)
@ -305,6 +314,14 @@ def read_pobs(fname, full_output=False, gz=True, separator_insertion=None):
by "|%s" % (separator_insertion) when constructing the names of the replica.
int: Insert the separator "|" at the position given by separator_insertion.
None (default): Replica names remain unchanged.
Returns
-------
res : list[Obs]
Imported data
or
res : dict
Imported data and meta-data
"""
if not fname.endswith('.xml') and not fname.endswith('.gz'):
@ -402,6 +419,14 @@ def import_dobs_string(content, noempty=False, full_output=False, separator_inse
True (default): separator "|" is inserted after len(ensname), assuming that the
ensemble name is a prefix to the replica name.
None or False: No separator is inserted.
Returns
-------
res : list[Obs]
Imported data
or
res : dict
Imported data and meta-data
"""
root = et.fromstring(content)
@ -567,6 +592,14 @@ def read_dobs(fname, noempty=False, full_output=False, gz=True, separator_insert
True (default): separator "|" is inserted after len(ensname), assuming that the
ensemble name is a prefix to the replica name.
None or False: No separator is inserted.
Returns
-------
res : list[Obs]
Imported data
or
res : dict
Imported data and meta-data
"""
if not fname.endswith('.xml') and not fname.endswith('.gz'):
@ -669,6 +702,11 @@ def create_dobs_string(obsl, name, spec='dobs v1.0', origin='', symbol=[], who=N
enstags : dict
Provide alternative enstag for ensembles in the form enstags = {ename: enstag}
Otherwise, the ensemble name is used.
Returns
-------
xml_str : str
XML string generated from the data
"""
if enstags is None:
enstags = {}
@ -857,6 +895,10 @@ def write_dobs(obsl, fname, name, spec='dobs v1.0', origin='', symbol=[], who=No
Otherwise, the ensemble name is used.
gz : bool
If True, the output is a gzipped XML. If False, the output is a XML file.
Returns
-------
None
"""
if enstags is None:
enstags = {}