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]: Be more explicit about development dependencies #23831

Open
greglucas opened this issue Sep 8, 2022 · 1 comment
Open

[Doc]: Be more explicit about development dependencies #23831

greglucas opened this issue Sep 8, 2022 · 1 comment

Comments

@greglucas
Copy link
Contributor

Documentation Link

https://matplotlib.org/devdocs/devel/dependencies.html#dependencies-for-testing-matplotlib

Problem

It is somewhat unclear what explicit dependencies are needed for running certain classes of tests and why certain tests are skipped.

Suggested improvement

Inkscape "to render SVG files" -> "for SVG image tests". Perhaps turning the prose text after the dependency into a column next to the dependency. Another thought is to switch the order and put the reason for the dependency first and then list all of the requirements after that.

To run SVG image tests | Inkscape
To run PDF image tests | ghostscript
@story645
Copy link
Member

story645 commented Sep 8, 2022

A thing I'd like is maybe moving our dependency sections https://matplotlib.org/devdocs/devel/dependencies.html into a table to make it more clear which are optional for what things.

dependency runtime testing docs notes
python r r r
inkscape o o o rendering and testing svgs

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

2 participants