RFC Initial pygmt.param.Pen class for specifying pen attributes #1239
+171
−1
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.
Description of proposed changes
Start a
pygmt.param.Pen
convenience class that generates a string which can be passed into GMT's pen (-W) parameter. The Pen class is structured to be under a 'param' folder. Added three basic unit tests to ensure various width/color/style combinationswill be output correctly. Note that this is still a basic implementation, and does not include advanced
+
modifiers as in https://docs.generic-mapping-tools.org/latest/plot.html#w.Preview API docs at https://pygmt-git-params-pen-gmt.vercel.app/api/generated/pygmt.param.Pen.html
Example code:
produces:
References:
Fixes #1173, part of #1082
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version