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 docstring #30

Merged
merged 5 commits into from
Apr 3, 2024
Merged

Fix docstring #30

merged 5 commits into from
Apr 3, 2024

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Mar 31, 2024

Progress of the PR

  • Enable numpydoc and nitpicky,
  • docstring updated (if appropriate),
  • 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:holospy build of this PR (link in github checks)
  • ready for review.

Copy link

codecov bot commented Mar 31, 2024

Codecov Report

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

Project coverage is 87.23%. Comparing base (8541538) to head (790e801).

Files Patch % Lines
holospy/tools.py 70.00% 3 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main      #30   +/-   ##
=======================================
  Coverage   87.23%   87.23%           
=======================================
  Files           7        7           
  Lines         329      329           
  Branches       73       73           
=======================================
  Hits          287      287           
  Misses         25       25           
  Partials       17       17           

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

@ericpre ericpre added this to the v0.2 milestone Mar 31, 2024
@ericpre ericpre added documentation Improvements or additions to documentation type: enhancement status: needs review labels Mar 31, 2024
@ericpre ericpre requested a review from jlaehne March 31, 2024 18:39
@@ -25,18 +25,18 @@


def estimate_sideband_position(
holo_data, holo_sampling, central_band_mask_radius=None, sb="lower", high_cf=True
data, sampling, central_band_mask_radius=None, sb="lower", high_cf=True
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proposed renaming of parameters does make sense after the split, but shouldn't it be mentioned explicitly in the changelog?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@ericpre ericpre requested a review from jlaehne April 1, 2024 09:23
@ericpre ericpre merged commit a8bb882 into hyperspy:main Apr 3, 2024
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type: enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants