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

[BREAKING] Modify checks and improve docs #449

Merged
merged 1 commit into from
Sep 5, 2024
Merged

[BREAKING] Modify checks and improve docs #449

merged 1 commit into from
Sep 5, 2024

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Sep 5, 2024

Warning

Breaking changes:

  • remove check_hessian
  • rename check_twoarg into check_inplace

Tip

Terminology overhaul in the docs: 1-argument/2-argument functions become out-of-place/in-place functions.
Not to be confused with out-of-place/in-place operators!

Preview link: https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/previews/PR449


DI source

  • Remove check_hessian and rename check_twoarg into check_inplace
  • Rename internal traits

DI docs

  • Adapt to new terminology
  • Refresh tutorials

DI extensions

  • Adapt to new internal traits

DI tests

  • Remove uses of check_hessian

@gdalle gdalle linked an issue Sep 5, 2024 that may be closed by this pull request
@gdalle gdalle marked this pull request as ready for review September 5, 2024 18:18
@codecov-commenter
Copy link

codecov-commenter commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.52%. Comparing base (1069266) to head (3818158).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #449      +/-   ##
==========================================
- Coverage   98.53%   98.52%   -0.01%     
==========================================
  Files         107      107              
  Lines        4295     4271      -24     
==========================================
- Hits         4232     4208      -24     
  Misses         63       63              
Flag Coverage Δ
DI 98.67% <100.00%> (-0.02%) ⬇️
DIT 98.22% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@gdalle gdalle merged commit a2793bd into main Sep 5, 2024
94 of 105 checks passed
@gdalle gdalle deleted the gd/docsandapi branch September 5, 2024 18:40
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.

Remove checks
2 participants