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

Fix import #90

Merged
merged 3 commits into from
Oct 15, 2024
Merged

Fix import #90

merged 3 commits into from
Oct 15, 2024

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Oct 12, 2024

Progress of the PR

  • Fix undocumented API that fall through the cracks in Extend public API and fix documentation #59 and is used in atomap.
  • Fix preferences import when hartree-slater GOS as reported in Drop Hartree Slater cross GOS? #20 (comment).
  • [n/a] docstring updated (if appropriate),
  • [n/a] update user guide (if appropriate),
  • [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.

@CSSFrancis, @jlaehne, I think we should make a patch release straightaway since atomap is using one of these import.

Copy link

codecov bot commented Oct 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.83%. Comparing base (62a32a3) to head (1f65ac5).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #90   +/-   ##
=======================================
  Coverage   88.82%   88.83%           
=======================================
  Files          77       77           
  Lines        7475     7476    +1     
  Branches     1024     1024           
=======================================
+ Hits         6640     6641    +1     
  Misses        568      568           
  Partials      267      267           

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

@jlaehne
Copy link
Contributor

jlaehne commented Oct 14, 2024

Would an intersphinx link to atomap in the changelog make sense or is that overkill?

@ericpre
Copy link
Member Author

ericpre commented Oct 15, 2024

It did cross my mind and I thought that this isn't necessary: for new features, it is convenient, because it send to the relevant part of the documentation but here this is not the case.

@ericpre ericpre merged commit 1dffbe2 into hyperspy:main Oct 15, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants