search

Spectral-Analysis-UPB / PyZEAL

Project dealing with the numerical calculation of zeros, poles and residues of holomorphic and meromorphic functions. It aspires to be a PYthon ZEAL (ZEros of AnaLytic functions, a Fortran90 package) successor.
https://pyzeal.readthedocs.io/en/latest/
GNU General Public License v3.0
4 stars 1 forks source link

Add more docstrings to non-settings related files #14

Closed lwasmuth closed 1 year ago

lwasmuth commented 1 year ago

Add docstrings, adapt documentation

codecov-commenter commented 1 year ago

Codecov Report

Base: 75.27% // Head: 75.27% // No change to project coverage :thumbsup:

Coverage data is based on head (72a2727) compared to base (d1388f8). Patch coverage: 100.00% of modified lines in pull request are covered.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #14 +/- ## ======================================= Coverage 75.27% 75.27% ======================================= Files 33 33 Lines 991 991 ======================================= Hits 746 746 Misses 245 245 ``` | [Impacted Files](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB) | Coverage Δ | | |---|---|---| | [src/pyzeal/finder\_interface.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbC9maW5kZXJfaW50ZXJmYWNlLnB5) | `96.15% <ø> (ø)` | | | [src/pyzeal/parallel\_finder.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbC9wYXJhbGxlbF9maW5kZXIucHk=) | `84.72% <ø> (ø)` | | | [src/pyzeal/rootfinder.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbC9yb290ZmluZGVyLnB5) | `79.48% <ø> (ø)` | | | [src/pyzeal\_algorithms/simple\_holo.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF9hbGdvcml0aG1zL3NpbXBsZV9ob2xvLnB5) | `88.69% <ø> (ø)` | | | [src/pyzeal\_logging/log\_levels.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF9sb2dnaW5nL2xvZ19sZXZlbHMucHk=) | `100.00% <ø> (ø)` | | | [src/pyzeal\_logging/logger\_facade.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF9sb2dnaW5nL2xvZ2dlcl9mYWNhZGUucHk=) | `56.25% <ø> (ø)` | | | [src/pyzeal\_settings/invalid\_setting\_exception.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF9zZXR0aW5ncy9pbnZhbGlkX3NldHRpbmdfZXhjZXB0aW9uLnB5) | `66.66% <ø> (ø)` | | | [.../pyzeal\_utils/pyzeal\_containers/plain\_container.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF91dGlscy9weXplYWxfY29udGFpbmVycy9wbGFpbl9jb250YWluZXIucHk=) | `64.70% <ø> (ø)` | | | [...zeal\_utils/pyzeal\_containers/rounding\_container.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF91dGlscy9weXplYWxfY29udGFpbmVycy9yb3VuZGluZ19jb250YWluZXIucHk=) | `70.96% <ø> (ø)` | | | [src/pyzeal\_utils/root\_context.py](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB#diff-c3JjL3B5emVhbF91dGlscy9yb290X2NvbnRleHQucHk=) | `100.00% <ø> (ø)` | | | ... and [2 more](https://codecov.io/gh/Spectral-Analysis-UPB/PyZEAL/pull/14?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Spectral-Analysis-UPB)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.