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

Remove "Full test" section from the installation guide #1200

Closed
seisman opened this issue Apr 11, 2021 · 2 comments · Fixed by #1206
Closed

Remove "Full test" section from the installation guide #1200

seisman opened this issue Apr 11, 2021 · 2 comments · Fixed by #1206
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@seisman
Copy link
Member

seisman commented Apr 11, 2021

The installation guide provides commands to run the PyGMT full test:

import pygmt
pygmt.show_versions()
pygmt.test()

The commands no longer work since we just migrated all baseline images to DVC (#1036, #1131), and the source and binary distributions no longer contain the baseline images (#1086).

Users who install PyGMT using conda or pip won't have baseline images in their PyGMT installation directory, and there is no easy to download these baseline images automatically without negative effects (#1111 (comment)). So it means users won't be able to run full tests anymore.

On the other hand, running full tests is unnecessary for most users:

  • PyGMT should work correctly if the quick check passes
  • Users may use different GMT versions, thus some tests may break. The failing tests may cause more confusion

I think we should remove the "Full test" section from the installation instructions.

Comments?

@seisman seisman added the question Further information is requested label Apr 11, 2021
@core-man
Copy link
Member

Sounds good. I never ran the full test for the software used in my studies.

@maxrjones
Copy link
Member

Agreed, sounds good.

@seisman seisman added documentation Improvements or additions to documentation good first issue Good for newcomers and removed question Further information is requested labels Apr 12, 2021
@seisman seisman added this to the 0.4.0 milestone Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants