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

Doc and import improvement #4 #72

Merged
merged 10 commits into from
Dec 14, 2022
Merged

Doc and import improvement #4 #72

merged 10 commits into from
Dec 14, 2022

Conversation

jlaehne
Copy link
Contributor

@jlaehne jlaehne commented Dec 7, 2022

Description of the change

Follow up on #47, #59, and #64 adresses #38. For readers with folder names from I...M+dens.

Progress of the PR

  • Change implemented (can be split into several points),
  • update docstring (if appropriate),
  • update user guide (if appropriate),
  • add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
  • add tests,
  • ready for review.

@codecov
Copy link

codecov bot commented Dec 7, 2022

Codecov Report

Base: 84.11% // Head: 84.27% // Increases project coverage by +0.15% 🎉

Coverage data is based on head (b86f0ab) compared to base (7a34b06).
Patch coverage: 96.92% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #72      +/-   ##
==========================================
+ Coverage   84.11%   84.27%   +0.15%     
==========================================
  Files          56       65       +9     
  Lines        8411     8481      +70     
  Branches     1890     1894       +4     
==========================================
+ Hits         7075     7147      +72     
+ Misses        877      875       -2     
  Partials      459      459              
Impacted Files Coverage Δ
rsciio/__init__.py 100.00% <ø> (ø)
rsciio/tiff/_api.py 88.24% <ø> (ø)
rsciio/zspy/_api.py 92.77% <ø> (ø)
rsciio/mrc/_api.py 21.42% <60.00%> (ø)
rsciio/blockfile/_api.py 95.31% <100.00%> (ø)
rsciio/dens/__init__.py 100.00% <100.00%> (ø)
rsciio/dens/_api.py 83.92% <100.00%> (ø)
rsciio/docstrings.py 100.00% <100.00%> (ø)
rsciio/image/__init__.py 100.00% <100.00%> (ø)
rsciio/image/_api.py 91.86% <100.00%> (ø)
... and 14 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jlaehne
Copy link
Contributor Author

jlaehne commented Dec 8, 2022

Failing test is due to old loading from the api in hyperspy/misc/eels/eelsdb.py . See hyperspy/hyperspy#3074

@ericpre ericpre merged commit 34528e1 into hyperspy:main Dec 14, 2022
@ericpre ericpre mentioned this pull request Dec 14, 2022
3 tasks
@jlaehne jlaehne deleted the doc-i-m branch December 14, 2022 20:48
@jlaehne jlaehne mentioned this pull request Jan 16, 2023
7 tasks
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.

2 participants