Skip to content

DOC: remove test from README.rst #21357

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

Merged
merged 1 commit into from
Oct 14, 2021

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Oct 14, 2021

PR Summary

The README shows up on pypi, and it tells everyone to run pytest after installing. I don't think most users should run pytest, and we already link to the contributing page below, where testing is covered in loving detail.

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@tacaswell tacaswell added this to the v3.5.0 milestone Oct 14, 2021
@tacaswell
Copy link
Member

Having this be the readme on pypi is also a choice we are making via:

long_description=Path("README.rst").read_text(encoding="utf-8"),

we may want to differentiate between what shows up on GitHub and what shows up on pypi?

@jklymak
Copy link
Member Author

jklymak commented Oct 14, 2021

Happy to do that instead. I didn't realize we could change it easily. However, I'm not sure that little section adds much to the github page either.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One cannot simply run tests after a regular install, because testing needs additional dependencies and reference images. That‘s beyond the scope of the readme. So let‘s remove the section here completely.

@timhoffm timhoffm merged commit 3d940e3 into matplotlib:master Oct 14, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 14, 2021
QuLogic added a commit that referenced this pull request Oct 14, 2021
…357-on-v3.5.x

Backport PR #21357 on branch v3.5.x (DOC: remove test from README.rst)
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants