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

Add return type documentation for util.have_jax() and is_jax_compatible() #4005

Merged
merged 6 commits into from
Apr 12, 2024

Conversation

raghuramshankar
Copy link
Contributor

Description

Fixes #4004

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@raghuramshankar raghuramshankar marked this pull request as ready for review April 12, 2024 10:11
@raghuramshankar raghuramshankar requested a review from a team as a code owner April 12, 2024 10:11
Copy link
Sponsor Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Thanks, can you please add the description I suggested before we merge?

pybamm/util.py Show resolved Hide resolved
pybamm/util.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Apr 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (62fdd5f) to head (b2aa523).
Report is 1 commits behind head on develop.

❗ Current head b2aa523 differs from pull request most recent head 65ccc23. Consider uploading reports for the commit 65ccc23 to get more accurate results

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4005   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          257      257           
  Lines        21242    21242           
========================================
  Hits         21154    21154           
  Misses          88       88           

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

pybamm/util.py Outdated Show resolved Hide resolved
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
@kratman kratman merged commit 8cd1cec into pybamm-team:develop Apr 12, 2024
37 of 38 checks passed
js1tr3 pushed a commit to js1tr3/PyBaMM that referenced this pull request Aug 12, 2024
…le() (pybamm-team#4005)

* add return type for util.have_jax() and is_jax_compatible()

* add description

* Update pybamm/util.py

Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>

---------

Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
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.

pybamm.have_jax and pybamm.is_jax_compatible: document return type (bool?)
4 participants