Skip to content

Breaking changes targeting v0.14 #80

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

Closed
wants to merge 1 commit into from
Closed

Breaking changes targeting v0.14 #80

wants to merge 1 commit into from

Conversation

mikeingold
Copy link
Collaborator

@mikeingold mikeingold commented Sep 23, 2024

Several significant breaking changes are planned for this major version. Some of these changes may be implemented in sub-branches and then merged into this one for ease of review.

Plans

Branch: breaking-rules

  • Rename IntegrationAlgorithm to IntegrationRule, change references from "algorithm", "settings", etc to "rule"

Others

  • Convert FP to a keyword argument.
    • Figure out how to ensure clean pass-through of arguments from alias functions, e.g. lineintegral -> integral -> _integral?
  • Add "Why Specialized" lines to each specialization source file: why does this geometry require specialized methods vs the generalized ones?
  • Remove jacobian, derivative, and unitdirection from exports -- these originated when the package's trajectory was less clear, and behave more like interesting internal tools

Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.35%. Comparing base (8d5f81a) to head (b2f7187).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #80   +/-   ##
=======================================
  Coverage   90.35%   90.35%           
=======================================
  Files          16       16           
  Lines         311      311           
=======================================
  Hits          281      281           
  Misses         30       30           

☔ 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