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

Readme to markdown #3351

Merged
merged 3 commits into from Apr 11, 2024
Merged

Readme to markdown #3351

merged 3 commits into from Apr 11, 2024

Conversation

jlaehne
Copy link
Contributor

@jlaehne jlaehne commented Apr 9, 2024

Replaces #3350

Copy link

codecov bot commented Apr 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.54%. Comparing base (3b350ff) to head (6867e4f).

Additional details and impacted files
@@                  Coverage Diff                   @@
##           RELEASE_next_minor    #3351      +/-   ##
======================================================
- Coverage               80.55%   80.54%   -0.01%     
======================================================
  Files                     147      147              
  Lines                   21871    21871              
  Branches                 5144     5144              
======================================================
- Hits                    17618    17616       -2     
- Misses                   3036     3037       +1     
- Partials                 1217     1218       +1     

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

Copy link
Member

@ericpre ericpre left a comment

Choose a reason for hiding this comment

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

I ran twine check on the distribution file and it didn't complain!

Add a changelog entry?

@jlaehne
Copy link
Contributor Author

jlaehne commented Apr 11, 2024

Add a changelog entry?
done (I'm always not so sure whether we should include all minor maintenances in the changelog)

@ericpre ericpre merged commit f3ca88e into hyperspy:RELEASE_next_minor Apr 11, 2024
26 of 28 checks passed
@ericpre ericpre added this to the v2.1 milestone Apr 11, 2024
@ericpre
Copy link
Member

ericpre commented Apr 11, 2024

In this case, I think the changelog is useful for developers, to be able to find the pull request easily, when it is fixing a typo or a dead link, adding a release note is not necessary.

@jlaehne jlaehne deleted the readme branch April 11, 2024 13:56
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.

None yet

2 participants