lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-11-30 21:16:53 +01: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

2
pyerrors/roots.py
View file

@ -24,7 +24,7 @@ def find_root(d, func, guess=1.0, **kwargs):
Returns
-------
Obs
res : Obs
`Obs` valued root of the function.
'''
d_val = np.vectorize(lambda x: x.value)(np.array(d))