Skip to content

What does "Use Vendor the code instead" mean? #23244

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.

Sign up for GitHub

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

Jump to bottom
Closed
pllim opened this issue Jun 10, 2022 · 3 comments
Closed

What does "Use Vendor the code instead" mean? #23244

pllim opened this issue Jun 10, 2022 · 3 comments

Comments

@pllim
Copy link

pllim commented Jun 10, 2022

We started getting this deprecation warning but I don't know what to do with it. Is there somewhere in your documentation that would explain this more? Thanks! Example log: https://github.com/astropy/astropy/runs/6838665326?check_suite_focus=true

matplotlib._api.deprecation.MatplotlibDeprecationWarning: The checkdep_usetex function
was deprecated in Matplotlib 3.6 and will be removed two minor releases later.
Use Vendor the code instead.

We use it like this:

 TEX_UNAVAILABLE = not matplotlib.checkdep_usetex(True)

Hard to tell from the traceback where this is coming from inside matplotlib because the warning went through a generic matplotlib/_api/deprecation.py.
@pllim pllim mentioned this issue Jun 10, 2022
Merged
10 tasks
@timhoffm
Copy link
Member

timhoffm commented Jun 10, 2022 •
edited
Loading

@pllim Sorry for the confusion. The message is a bit awkward because it’s generated via a template.

checkdep_usetex was not intended as public API and we are going to remove it. If you need the functionality you should take a copy of the code and maintain it yourself.

@pllim
Copy link
Author

pllim commented Jun 11, 2022

That is unfortunate. Won't that promote code duplication, especially since you'll still be using it internally anyway? Anyways, my original question is answered, so I am closing the issue. Thanks!

@pllim pllim closed this as completed Jun 11, 2022
@pllim pllim mentioned this issue Jun 11, 2022
Open
@jklymak
Copy link
Member

jklymak commented Jun 11, 2022

Downstream libraries (or anyone) are certainly welcome to use our private methods. We simply don't guarantee their stability. If you want to avoid the warning just use the private method (but don't raise an issue if it breaks in the future).

@QuLogic QuLogic mentioned this issue Aug 23, 2022
Merged
1 task
@zerothi zerothi mentioned this issue Nov 6, 2023
Closed
@sporring sporring mentioned this issue Jan 23, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jklymak @pllim @timhoffm