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

Cleanup documentation and fix a few minor things #448

Merged
merged 5 commits into from
Feb 16, 2024
Merged

Cleanup documentation and fix a few minor things #448

merged 5 commits into from
Feb 16, 2024

Conversation

bhazelton
Copy link
Member

@bhazelton bhazelton commented Feb 15, 2024

Description

This fixes a number of minor issues:

  • Add information about citing pyuvsim via the JOSS paper to the README
  • Decrease the tolerance for analytic diffuse tests and add comments explaining the choices
  • Clarify the deprecation process in the README
  • Replace the utils.strip_extension function with a call to os.path.splitext

I also updated the CI yamls to use pytest-xdist where possible to try to speed it up.

Motivation and Context

fixes #361
fixes #325
fixes #268
fixes #381

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Reference simulation update or replacement
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change
  • Other: Refactoring and test improvements.

Checklist:

For all pull requests:

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

Copy link

codecov bot commented Feb 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (abb8a87) 99.55% compared to head (7afb6ac) 99.55%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #448      +/-   ##
==========================================
- Coverage   99.55%   99.55%   -0.01%     
==========================================
  Files          12       12              
  Lines        2239     2229      -10     
==========================================
- Hits         2229     2219      -10     
  Misses         10       10              

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

Copy link
Member

@jpober jpober left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@jpober jpober merged commit 64ee930 into main Feb 16, 2024
29 checks passed
@jpober jpober deleted the cleanup branch February 16, 2024 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants