Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #1 #88

Merged
merged 10 commits into from
Aug 31, 2022
Merged

Update documentation #1 #88

merged 10 commits into from
Aug 31, 2022

Conversation

AgnesBaud
Copy link
Member

@AgnesBaud AgnesBaud commented Feb 25, 2022

Description

Update moonstone's diversity (and other) documentation + Creation of a jupyter notebook Tutorial

Definition of Done

  • New code is tested with unit tests
  • Documentation has been updated
  • Pull Request has been revised by a maintainer of the project

@AgnesBaud AgnesBaud added the documentation Improvements or additions to documentation label Feb 25, 2022
@AgnesBaud AgnesBaud self-assigned this Feb 25, 2022
@codecov-commenter
Copy link

codecov-commenter commented Feb 25, 2022

Codecov Report

Merging #88 (ee6cd36) into master (ed14b68) will increase coverage by 0.14%.
The diff coverage is 92.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #88      +/-   ##
==========================================
+ Coverage   64.28%   64.43%   +0.14%     
==========================================
  Files          60       60              
  Lines        2831     2837       +6     
==========================================
+ Hits         1820     1828       +8     
+ Misses       1011     1009       -2     
Flag Coverage Δ
unittests 64.43% <92.00%> (+0.14%) ⬆️

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

Impacted Files Coverage Δ
moonstone/utils/dict_operations.py 100.00% <ø> (ø)
moonstone/analysis/diversity/alpha.py 96.22% <83.33%> (-1.74%) ⬇️
moonstone/analysis/diversity/base.py 81.56% <92.85%> (+0.20%) ⬆️
moonstone/analysis/diversity/beta.py 79.81% <100.00%> (ø)
moonstone/core/module_base.py 78.57% <0.00%> (+10.71%) ⬆️

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 ed14b68...ee6cd36. Read the comment docs.

@AgnesBaud AgnesBaud marked this pull request as draft February 25, 2022 18:25
@AgnesBaud AgnesBaud marked this pull request as ready for review August 31, 2022 13:47
@AgnesBaud AgnesBaud changed the title Update documentation Update documentation #1 Aug 31, 2022
@AgnesBaud AgnesBaud merged commit 70b5b20 into master Aug 31, 2022
@AgnesBaud AgnesBaud deleted the update_doc branch August 31, 2022 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants