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

Migrate public APIs containing typos #2548

Closed
stefan6419846 opened this issue Mar 27, 2024 · 2 comments · Fixed by #2550
Closed

Migrate public APIs containing typos #2548

stefan6419846 opened this issue Mar 27, 2024 · 2 comments · Fixed by #2550
Labels
breaking-change A planned breaking change

Comments

@stefan6419846
Copy link
Collaborator

We currently have some public APIs with typos which should be migrated accordingly:

  • pypdf.constants.Ressources to pydf.constants.Resources
  • pypdf.generic._data_structures.Destination.childs to pypdf.generic._data_structures.Destination.children (already has a TODO)
@pubpub-zz
Copy link
Collaborator

a

  • pypdf.constants.Ressources to pydf.constants.Resources

  • pypdf.generic._data_structures.Destination.childs to pypdf.generic._data_structures.Destination.children (already has a TODO)

I doubt many people use this in there own code : I propose to create an alias and use the depreciating process

@stefan6419846
Copy link
Collaborator Author

stefan6419846 commented Mar 27, 2024

While there might not be many users, we should still use our deprecation process while it makes sense (although this might be a bit trickier for the Ressources case as these are just constants and this class is never being instantiated where we might have to work with something like django.utils.functional.classproperty).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change A planned breaking change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants