[DOC]: Add Zenodo shield and improve documentation #247

Merged

synchon merged 7 commits from chore/update-docs into main

2023-07-24 13:42:45 +00:00

synchon commented

2023-07-24 07:57:32 +00:00

(Migrated from github.com)

description of feature/fix
tests added/passed
add an entry for the latest changes

This PR adds Zenodo shield in README and improves the docs.

* [x] description of feature/fix * [x] tests added/passed * [x] add an entry for the latest changes This PR adds Zenodo shield in README and improves the docs.

codecov[bot] commented

2023-07-24 07:58:10 +00:00

(Migrated from github.com)

Codecov Report

Merging #247 (8f13944) into main (3e0a615) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #247   +/-   ##
=======================================
  Coverage   93.10%   93.10%           
=======================================
  Files          84       84           
  Lines        3714     3714           
  Branches      722      722           
=======================================
  Hits         3458     3458           
  Misses        160      160           
  Partials       96       96

Flag	Coverage Δ
docs	`100.00% <ø> (ø)`
junifer	`93.10% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
junifer/storage/pandas_base.py	`95.55% <ø> (ø)`
junifer/data/masks.py	`96.42% <100.00%> (ø)`

## [Codecov](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#247](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (8f13944) into [main](https://app.codecov.io/gh/juaml/junifer/commit/3e0a615eaaadfc066098b1af0b9108012496402c?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (3e0a615) will **not change** coverage. > The diff coverage is `100.00%`. [![Impacted file tree graph](https://app.codecov.io/gh/juaml/junifer/pull/247/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #247 +/- ## ======================================= Coverage 93.10% 93.10% ======================================= Files 84 84 Lines 3714 3714 Branches 722 722 ======================================= Hits 3458 3458 Misses 160 160 Partials 96 96 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `93.10% <100.00%> (ø)` | | 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=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/storage/pandas\_base.py](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9zdG9yYWdlL3BhbmRhc19iYXNlLnB5) | `95.55% <ø> (ø)` | | | [junifer/data/masks.py](https://app.codecov.io/gh/juaml/junifer/pull/247?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9kYXRhL21hc2tzLnB5) | `96.42% <100.00%> (ø)` | |

github-actions[bot] commented

2023-07-24 08:04:40 +00:00

(Migrated from github.com)

PR Preview Action v1.4.4
Preview removed because the pull request was closed.
2023-07-24 13:47 UTC

[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.4.4 :---: Preview removed because the pull request was closed. 2023-07-24 13:47 UTC

fraimondo (Migrated from github.com) approved these changes

2023-07-24 12:36:01 +00:00