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

DOC/DEPR: eps_writer's documentation is misleading #4816

Open
neutrinoceros opened this issue Feb 14, 2024 · 0 comments
Open

DOC/DEPR: eps_writer's documentation is misleading #4816

neutrinoceros opened this issue Feb 14, 2024 · 0 comments
Labels
deprecation deprecate features or remove deprecated ones docs question

Comments

@neutrinoceros
Copy link
Member

In a recent ticket, it was brought up that the way eps_writer is advertised in docs may be misleading to newcomers. In particular, when browsing docs, one may look for Publication Ready Figures, and overlook everything else, missing that the functionality they need is actually built into SlicePlot and the likes.
I think it should be made clear in docs that eps_writer isn't our main API for saving image files, either by renaming this section or adding a warning to it.

It may also be that the subpackage is simply not relevant anymore now that matplotlib natively supports .pdf and .eps outputs.
I also note that there's an open ticket (#3498) to make eps_writer a solo extension package, but it hasn't received any attention that I know of. So what should be done with it ? From where I stand, it seems ripe for deprecation, but I may be missing reasons why not.

@neutrinoceros neutrinoceros added question docs deprecation deprecate features or remove deprecated ones labels Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation deprecate features or remove deprecated ones docs question
Projects
None yet
Development

No branches or pull requests

1 participant