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

Improved documentation #10

Merged
merged 9 commits into from
Sep 17, 2022
Merged

Improved documentation #10

merged 9 commits into from
Sep 17, 2022

Conversation

AldoGl
Copy link
Contributor

@AldoGl AldoGl commented Aug 29, 2022

Proposed changes

I improved the documentation by fixing a broken link, splitting a webpage in two extended ones, expanding some descriptions and adding an illustration

@AldoGl AldoGl force-pushed the improve_documentation branch from b3cc17c to c1e665c Compare September 9, 2022 11:55
@AldoGl AldoGl force-pushed the improve_documentation branch from c1e665c to c0d0ab1 Compare September 9, 2022 12:18
@AldoGl AldoGl force-pushed the improve_documentation branch from 1890597 to 15615c2 Compare September 9, 2022 12:42
@codecov-commenter
Copy link

codecov-commenter commented Sep 9, 2022

Codecov Report

Merging #10 (4cf2be1) into main (04ef27d) will decrease coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #10      +/-   ##
==========================================
- Coverage   99.46%   99.46%   -0.01%     
==========================================
  Files          25       25              
  Lines        1116     1112       -4     
==========================================
- Hits         1110     1106       -4     
  Misses          6        6              
Impacted Files Coverage Δ
black_it/loss_functions/msm.py 97.43% <0.00%> (-0.07%) ⬇️
black_it/samplers/halton.py 100.00% <0.00%> (ø)
black_it/loss_functions/fourier.py 100.00% <0.00%> (ø)
black_it/utils/sqlite3_checkpointing.py 100.00% <0.00%> (ø)

@Francesco-De-Sclavis-BdI

I've just realized I cannot see the image at the top of "description.md" when serving the documentation in local. There may be an issue with the path.

@AldoGl
Copy link
Contributor Author

AldoGl commented Sep 17, 2022

I've just realized I cannot see the image at the top of "description.md" when serving the documentation in local. There may be an issue with the path.

Well I checked the path and it is ok. I think the figure will appear as we merge the PR

@AldoGl AldoGl merged commit ce8c8f8 into main Sep 17, 2022
@AldoGl AldoGl deleted the improve_documentation branch September 17, 2022 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants