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

Completing documentation #179

Merged
merged 35 commits into from
Jul 19, 2021
Merged

Completing documentation #179

merged 35 commits into from
Jul 19, 2021

Conversation

thuiop
Copy link
Collaborator

@thuiop thuiop commented Jul 12, 2021

This PR is for documenting on the recent changes, including multiresolution and command line interface. It should be merged after #178 .
For now I updated some notebooks, splitted the "advanced features" notebook in two, and added notebook validation using nbval, as Mike Jarvis suggested.

@thuiop thuiop added refactor code refactoring docs documentation labels Jul 12, 2021
@thuiop thuiop added this to the v1.0.0 milestone Jul 12, 2021
@thuiop thuiop self-assigned this Jul 12, 2021
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@thuiop
Copy link
Collaborator Author

thuiop commented Jul 12, 2021

@ismael-mendoza You may want to add something about the CLI in the documentation ?

@thuiop thuiop linked an issue Jul 13, 2021 that may be closed by this pull request
@ismael-mendoza
Copy link
Collaborator

@ismael-mendoza You may want to add something about the CLI in the documentation ?

Thanks @thuiop for starting this, yes, I will add some docs for documentation soon

@thuiop thuiop linked an issue Jul 14, 2021 that may be closed by this pull request
@ismael-mendoza ismael-mendoza force-pushed the complete-documentation branch from 2bf6651 to f256da0 Compare July 16, 2021 19:09
@codecov
Copy link

codecov bot commented Jul 19, 2021

Codecov Report

Merging #179 (f54e080) into main (010c7dc) will decrease coverage by 0.64%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #179      +/-   ##
==========================================
- Coverage   86.20%   85.55%   -0.65%     
==========================================
  Files          13       13              
  Lines        1529     1530       +1     
==========================================
- Hits         1318     1309       -9     
- Misses        211      221      +10     
Flag Coverage Δ
unittests 85.55% <100.00%> (-0.65%) ⬇️

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

Impacted Files Coverage Δ
btk/metrics.py 94.85% <ø> (ø)
btk/survey.py 93.26% <ø> (ø)
btk/draw_blends.py 84.82% <100.00%> (ø)
btk/measure.py 86.87% <100.00%> (-0.09%) ⬇️
btk/plot_utils.py 80.05% <100.00%> (-2.51%) ⬇️
btk/sampling_functions.py 64.90% <100.00%> (ø)

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 010c7dc...f54e080. Read the comment docs.

@ismael-mendoza ismael-mendoza merged commit ae83321 into main Jul 19, 2021
@ismael-mendoza ismael-mendoza deleted the complete-documentation branch July 19, 2021 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation refactor code refactoring
Projects
None yet
3 participants