Add guidelines for types of tests to write#796
Add guidelines for types of tests to write#796seisman merged 9 commits intoGenericMappingTools:masterfrom
Conversation
…le; changing units from US to SI
# Conflicts: # examples/projections/cyl/cyl_transverse_mercator.py # examples/projections/cyl/cyl_universal_transverse_mercator.py
|
@weiji14 @seisman I added the recommendations we discussed, but I'm still a little confused on how we should address testing aliases and the basic creation of plots. I could see how someone could get confused looking at the testing guidelines, which don't recommend focusing on GMT aliases and functions, and then seeing that the majority of test files focus on testing the creation of plots and how the aliases work. |
There may be some misunderstanding here. Could you point out some tests which you think don't follow the guidelines? |
|
@seisman I probably should have specified that I'm looking at the plotting functions, as the majority of the tests that work with GMT under the hood don't focus on testing plotting aliases. Looking at |
I see your points. Some of the tests were written years ago, and we didn't have any guidelines at that time (we're still learning to make the project better and developer-friendly). If you look at the core codes of the |
As discussed in #771, this PR adds recommended guidelines to CONTRIBUTING.md for types of tests to write. It emphasizes testing on Python-specific code over GMT aliases and functions.