zwicker-group / py-pde

Python package for solving partial differential equations using finite differences.
https://py-pde.readthedocs.io
MIT License
410 stars 52 forks source link

Improved documentation #474

Closed david-zwicker closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Attention: 286 lines in your changes are missing coverage. Please review.

Comparison is base (9ec2d9c) 87.92% compared to head (f5643f7) 87.14%. Report is 112 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #474 +/- ## ========================================== - Coverage 87.92% 87.14% -0.78% ========================================== Files 69 68 -1 Lines 10333 10783 +450 ========================================== + Hits 9085 9397 +312 - Misses 1248 1386 +138 ``` | [Flag](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group) | `87.14% <77.53%> (-0.78%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group) | Coverage Δ | | |---|---|---| | [pde/\_\_init\_\_.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [pde/fields/tensorial.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2ZpZWxkcy90ZW5zb3JpYWwucHk=) | `89.05% <100.00%> (+5.89%)` | :arrow_up: | | [pde/grids/\_mesh.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL19tZXNoLnB5) | `94.26% <100.00%> (ø)` | | | [pde/grids/boundaries/\_\_init\_\_.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL2JvdW5kYXJpZXMvX19pbml0X18ucHk=) | `100.00% <ø> (ø)` | | | [pde/grids/boundaries/axes.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL2JvdW5kYXJpZXMvYXhlcy5weQ==) | `94.57% <100.00%> (+0.04%)` | :arrow_up: | | [pde/grids/cartesian.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL2NhcnRlc2lhbi5weQ==) | `89.28% <100.00%> (-0.45%)` | :arrow_down: | | [pde/grids/operators/cylindrical\_sym.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL29wZXJhdG9ycy9jeWxpbmRyaWNhbF9zeW0ucHk=) | `100.00% <100.00%> (ø)` | | | [pde/grids/operators/polar\_sym.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL29wZXJhdG9ycy9wb2xhcl9zeW0ucHk=) | `100.00% <100.00%> (ø)` | | | [pde/grids/operators/spherical\_sym.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL29wZXJhdG9ycy9zcGhlcmljYWxfc3ltLnB5) | `97.46% <100.00%> (ø)` | | | [pde/grids/spherical.py](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group#diff-cGRlL2dyaWRzL3NwaGVyaWNhbC5weQ==) | `84.33% <100.00%> (-0.47%)` | :arrow_down: | | ... and [47 more](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group) | | ... and [3 files with indirect coverage changes](https://app.codecov.io/gh/zwicker-group/py-pde/pull/474/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=zwicker-group)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.