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

Update code contribution instructions and Nox sessions #262

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

namurphy
Copy link
Contributor

@namurphy namurphy commented Jun 28, 2024

  • I consolidated the Nox sessions for building docs into one. To build docs now, we run nox -s docs in the top-level directory.
  • I simplified the Nox session for running tests so that it's not specific to a particular version of Python, and made this session the default. To run tests now, we run nox -s tests. We can also run tests just with nox since we set the tests environment as the default.
  • I updated the contribution instructions to reflect these changes.
  • Templated some of the package config to be more "modern" and removed unused configs.
  • Fixed ruff linter issues that were skipped due to NOQAs
  • Reduced installed dependencies that were unused.

@namurphy namurphy changed the title Update code contribution instructions Update code contribution instructions and Nox sessions Jun 28, 2024
noxfile.py Outdated Show resolved Hide resolved
noxfile.py Outdated Show resolved Hide resolved
@nabobalis nabobalis force-pushed the contributing-instructions-update branch 3 times, most recently from b880b05 to 6ede75f Compare September 6, 2024 19:47
@@ -605,7 +605,7 @@ def calculate_TE_errors(map1, map2, T_e, EM, model_ratio, tresp1, tresp2, Trange
return T_error, EMerror, K1, K2


def make_results_maps(hdr1, hdr2, T_e, EM, T_error, EMerror, mask): # noqa: ARG001
def make_results_maps(hdr1, hdr2, T_e, EM, T_error, EMerror):
Copy link
Member

Choose a reason for hiding this comment

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

This was unused, so I removed it.

@nabobalis nabobalis force-pushed the contributing-instructions-update branch 2 times, most recently from 54b1768 to dd183f6 Compare September 6, 2024 20:01
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@nabobalis nabobalis marked this pull request as ready for review September 6, 2024 20:01
@nabobalis nabobalis force-pushed the contributing-instructions-update branch from dd183f6 to 9a2843d Compare September 6, 2024 20:04
@nabobalis nabobalis force-pushed the contributing-instructions-update branch from 9a2843d to 61d3558 Compare September 6, 2024 20:09

- repo: https://github.com/nbQA-dev/nbQA
rev: 1.8.7
hooks:
- id: nbqa-check-ast
name: validate Python notebooks
- id: nbqa-ruff
Copy link
Member

Choose a reason for hiding this comment

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

ruff handles notebook linting now. I don't think this is needed anymore.

Copy link
Collaborator

@wtbarnes wtbarnes left a comment

Choose a reason for hiding this comment

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

LGTM. My only reservation is conflicts with some of the changes to the effective area tests with #284

pyproject.toml Show resolved Hide resolved
xrtpy/image_correction/tests/test_remove_lightleak.py Outdated Show resolved Hide resolved
@nabobalis nabobalis force-pushed the contributing-instructions-update branch from 5ce85cf to 78baa2a Compare September 8, 2024 01:03
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.

3 participants