-
Notifications
You must be signed in to change notification settings - Fork 229
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Milestone
Description
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?
weiji14
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers