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

[36] Polish package for PyPI #37

Merged
merged 6 commits into from
Sep 4, 2024
Merged

[36] Polish package for PyPI #37

merged 6 commits into from
Sep 4, 2024

Conversation

MothNik
Copy link
Owner

@MothNik MothNik commented Sep 4, 2024

This pull request

✍️ Documentation

  • updates the README and bumps the version to 0.1b0

Closes #36

DOC:
- transitioned all plots from `.svg` to `.png`
- updated `README` with PyPI install
DOC:
- added code examples for Hermite functions and Chebyshev polynomials to the `README`
- added acknowledgements to `README`

BLD:
- increased version to `0.1b0`
DOC:
- improved resolution of equations ?
DOC:
- improved equation resolution ?
DOC:
- rebased equations on `.svg`-files again
@MothNik MothNik added ✍️ documentation Improvements or additions to documentation 📦 packaging Issues, additions, improvements related to packaging and building the package 🎁 Repository Changes regarding the repository as a whole labels Sep 4, 2024
@MothNik MothNik added this to the First Beta Release milestone Sep 4, 2024
@MothNik MothNik self-assigned this Sep 4, 2024
Copy link
Owner Author

@MothNik MothNik left a comment

Choose a reason for hiding this comment

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

Checked on top of CI ✅

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

DOC:
- structured development part of `README` more logically without interfering with the installation part in it
@MothNik MothNik merged commit 567c71a into main Sep 4, 2024
5 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 📦 packaging Issues, additions, improvements related to packaging and building the package 🎁 Repository Changes regarding the repository as a whole
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✍️ Polish package for PyPI 📦
1 participant