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

Documentation edits #2 [JOSS REVIEW] #197

Merged
merged 4 commits into from
Apr 24, 2024
Merged

Documentation edits #2 [JOSS REVIEW] #197

merged 4 commits into from
Apr 24, 2024

Conversation

PennyHow
Copy link
Contributor

These are all suggestions to improve the package documentation, as part of my JOSS review.

  • Introductory description of polartoolkit added to repo readme
  • Introductory description of polartoolkit added to readthedocs
  • Installation instructions added to repo readme

Feel free to merge and/or use this as a starting point to edit however you like. I'll write a more detailed justification of these changes in the JOSS review issue forum.

Copy link

codecov bot commented Apr 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 34.34%. Comparing base (9a8ae51) to head (91d3fb3).
Report is 62 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #197      +/-   ##
==========================================
- Coverage   35.43%   34.34%   -1.10%     
==========================================
  Files           6        6              
  Lines        2627     2693      +66     
==========================================
- Hits          931      925       -6     
- Misses       1696     1768      +72     

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

@mdtanker mdtanker merged commit 8791e96 into mdtanker:main Apr 24, 2024
13 of 18 checks passed
Copy link

welcome bot commented Apr 24, 2024

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉
We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants