Figure.colorbar: Move tests related to option -D as doctests #4372
+53
−55
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
added
maintenance
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors test organization by moving tests for the _alias_option_D helper function from a dedicated test file into inline doctests within the function's docstring. This improves code maintainability by co-locating tests with the implementation.
Changes:
- Removed the
test_colorbar_alias_Dtest function frompygmt/tests/test_colorbar.py - Removed unnecessary imports (
AliasSystemand_alias_option_D) from the test file - Added comprehensive doctests to
_alias_option_Dfunction inpygmt/src/colorbar.pycovering all previous test cases
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pygmt/tests/test_colorbar.py | Removed dedicated test function and its associated imports that are no longer needed |
| pygmt/src/colorbar.py | Added doctests to _alias_option_D function documenting all parameter combinations previously tested |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
seisman
added
final review call
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For complicated options like
colorbar's-D, we encapsulate the parsing logic in private helper functions such as_alias_option_D. These helpers let us test argument strings directly for any combination of parameters, rather than testing each combination throughFigure.colorbarcalls, which would mean a growing collection of tests and baseline images.Previously, we added dedicated tests like
test_colorbar_alias_Dinpygmt/tests/test_colorbar.py. This PR moves those tests inline as doctests within_alias_option_Dinstead. The benefits are:AliasSystemclass.