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

Extend public API and fix documentation #59

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Jun 16, 2024

Add back some functions which were removed when splitting from hyperspy. Some modules and functions that were not to the public API as listed in the API reference have been removed.

Progress of the PR

  • Add some functionalities back to public API,
  • Rename private modules to start with underscore to reduce their visibility and make more clear that they are not part of the public API,
  • docstring updated: there were still a lot of leftover from hyperspy,
  • update user guide: there were still a lot of leftover from hyperspy,
  • [n/a] added tests,
  • add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:exspy build of this PR (link in github checks)
  • ready for review.

@ericpre ericpre linked an issue Jun 16, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jun 16, 2024

Codecov Report

Attention: Patch coverage is 96.29630% with 3 lines in your changes missing coverage. Please review.

Project coverage is 87.80%. Comparing base (0f39dab) to head (df1702b).

Files Patch % Lines
exspy/material.py 80.00% 1 Missing ⚠️
exspy/utils/__init__.py 80.00% 1 Missing ⚠️
exspy/utils/eels.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   87.77%   87.80%   +0.03%     
==========================================
  Files          67       70       +3     
  Lines        7286     7301      +15     
  Branches     1179     1179              
==========================================
+ Hits         6395     6411      +16     
+ Misses        626      625       -1     
  Partials      265      265              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ericpre ericpre requested a review from jlaehne June 16, 2024 12:18
@ericpre ericpre added this to the v0.2 milestone Jun 16, 2024
@ericpre ericpre added bug-fix documentation Improvements or additions to documentation labels Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cannot find element database and get_xray_lines_near_energy()
1 participant