-
Notifications
You must be signed in to change notification settings - Fork 10
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
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
==========================================
+ Coverage 88.55% 88.62% +0.06%
==========================================
Files 67 76 +9
Lines 7341 7411 +70
Branches 1187 1192 +5
==========================================
+ Hits 6501 6568 +67
- Misses 571 574 +3
Partials 269 269 ☔ View full report in Codecov by Sentry. |
8e6d283
to
e56fb9c
Compare
e56fb9c
to
df1702b
Compare
…ta_to_edx_cross_section` to `zeta_to_cross_section`
df1702b
to
4335c5f
Compare
@ericpre I can review this today! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes look good to me. And probably should have been done a little bit ago.
My one hesitation is that this will move all of the functions in the misc
to a different place. Tecnically I think these were part of the public api even if they weren't documentated. It might be worthwhile to create a misc.py
file which redirects to the _misc.py
file and then raises a deprecation warning.
That's what we have been doing in pyxem just to catch people.
Co-authored-by: Carter Francis <csfrancis@wisc.edu>
b62f3b0
to
9e0d0be
Compare
Thank you @CSSFrancis for the review. I added a shim for the functionalities that have been added to the public API. Do you want to have another look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ericpre Looks great!
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
upcoming_changes
folder (seeupcoming_changes/README.rst
),docs/readthedocs.org:exspy
build of this PR (link in github checks)