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

Establish API deprecation and cleanup policy #361

Open
ocramz opened this issue Dec 17, 2023 · 0 comments
Open

Establish API deprecation and cleanup policy #361

ocramz opened this issue Dec 17, 2023 · 0 comments

Comments

@ocramz
Copy link
Collaborator

ocramz commented Dec 17, 2023

We are currently in a consolidation phase of the library, changing some type signatures and deprecating a bunch of redundant functions and instances. We should be following a consistent policy for cleaning up the namespace after a symbol has been deprecated.

E.g. :

  • version A.B.C : DEPRECATE function X
  • version A.(B+3*i) or (A+i): delete X (where i is a positive integer e.g. 2) . Depends on how we interpret the PVP.

Examples

Changing implementation

It happens that we might have to change the implementation of a user-facing function for security concerns (e.g sanitize header setting to avoid a potential attack on the client #92 ). In this case we introduce new names, deprecate the old ones and at the end of the deprecation cycle we might want to re-introduce the old names for the new implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant