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 Documentation and Prepare for 1.1.0 #76

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Conversation

ajfriedman22
Copy link
Collaborator

@ajfriedman22 ajfriedman22 commented Feb 11, 2025

Description

Update the documentation and prepare for creating version 1.1.0. Also add a MT-REXEE tutorial.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Unit test and CI update
  • Other

Todos

Notable points that this PR has either accomplished or will accomplish.

  • Update documentation
  • Create MT-REXEE tutorial

Checklist

Starting from PR #62, external PRs must keep the following checklist in the PR.

  • I have read the contributing guidelines.
  • My code follows the project’s coding style and is free from linting errors examined by flake8.
  • My code comes with docstrings that follow the NumPy docstrings standard.
  • I have updated the documentation in the docs directory if my changes affect the project's functionality or usage.
  • I have added new tests for new features or changes to existing features. The code coverage is at least 90%.
  • My code passes all unit tests and CI tests on CircleCI.

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.76%. Comparing base (9ba891b) to head (d7489b8).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #76   +/-   ##
=======================================
  Coverage   95.76%   95.76%           
=======================================
  Files          11       11           
  Lines        2549     2549           
=======================================
  Hits         2441     2441           
  Misses        108      108           

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

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.

1 participant