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

Deprecate the pre-APE 14 API #456

Closed
Cadair opened this issue Jun 14, 2023 · 3 comments
Closed

Deprecate the pre-APE 14 API #456

Cadair opened this issue Jun 14, 2023 · 3 comments
Milestone

Comments

@Cadair
Copy link
Collaborator

Cadair commented Jun 14, 2023

I am looking through the code trying to get to the bottom of #455 and the tangled web of how the APE 14 API calls the __call__ and invert methods which also have their own API semantics is driving me round the bend. Therefore I have the following proposal:

  • Refactor the existing code so that there is an "internal" forward and backward transform method with a very restrictive API. (Takes Quantity if the transform uses quantities and returns whatever the transform returns, some extra handling for numerical inverse etc).
  • Keep the current __call__ and invert methods and deprecate them.
  • Rework the APE 14 API methods so that they do any required pre- or post-processing before calling the "internal" forward and backward methods.

We could keep the old API deprecated for a long time (we don't even have to make it raise warnings or anything at this point), but I feel like there's no need to keep around both sets of API for a package which hasn't hit 1.0 yet?

@Cadair Cadair changed the title Deprecate the non-ape 14 API Deprecate the pre-APE 14 API Jun 14, 2023
@nden
Copy link
Collaborator

nden commented Jun 14, 2023

The API definitely needs to be cleaned up. I don't agree we should keep only the APE 14 API.

@Cadair
Copy link
Collaborator Author

Cadair commented Jun 14, 2023

What do you want to provide with the non-APE 14 API that is distinct from the APE 14 one? or is it just a stability thing?

@nden nden added this to the 1.0 milestone Sep 6, 2023
@Cadair
Copy link
Collaborator Author

Cadair commented Oct 12, 2023

As much of this as is going to be done is done in #457

@Cadair Cadair closed this as completed Oct 12, 2023
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

No branches or pull requests

2 participants