search

rvbCMTS / PySkinDose

MIT License
13 stars 4 forks source link

Add of background, description and contribute to documentation #36

Closed christoffergranberg closed 2 years ago

christoffergranberg commented 2 years ago

Update of documentation regarding background and contribution requests

codecov-commenter commented 2 years ago

Codecov Report

Merging #36 (e426086) into master (85d145f) will increase coverage by 4.46%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #36      +/-   ##
==========================================
+ Coverage   53.20%   57.66%   +4.46%     
==========================================
  Files          39       40       +1     
  Lines        1453     2251     +798     
==========================================
+ Hits          773     1298     +525     
- Misses        680      953     +273
Impacted Files Coverage Δ
.../pyskindose/plotting/create_geometry_plot_texts.py 26.92% <0.00%> (-14.26%) :arrow_down:
src/pyskindose/plotting/plot_geometry.py 57.14% <0.00%> (-9.53%) :arrow_down:
src/pyskindose/analyze_data.py 46.15% <0.00%> (-6.79%) :arrow_down:
src/pyskindose/plotting/create_geometry_plot.py 28.57% <0.00%> (-6.73%) :arrow_down:
...yskindose/plotting/create_plot_and_save_to_file.py 50.00% <0.00%> (-5.56%) :arrow_down:
src/pyskindose/plotting/create_mesh3d.py 15.38% <0.00%> (-5.31%) :arrow_down:
src/pyskindose/plotting/plot_event.py 43.33% <0.00%> (-4.04%) :arrow_down:
...ng/create_irradiation_event_procedure_plot_data.py 42.55% <0.00%> (-3.88%) :arrow_down:
src/pyskindose/corrections.py 71.60% <0.00%> (-3.40%) :arrow_down:
...pyskindose/plotting/create_setup_and_event_plot.py 41.50% <0.00%> (-3.32%) :arrow_down:
... and 26 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 85d145f...e426086. Read the comment docs.