Refactor Figure.meca() to better determine the data format code #1002
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
The
Figure.meca()
method is too complicated to read and maintain, and also has the lowest code coverage (~75%).I will try to refactor the method, but in separate PRs. Otherwise the changes would be too big to review.
This PR is the first step to refactor the codes. The old code uses nested if-else-statement to determine the data format (meca -S option) from parameters
convention
andcomponent
.The new code uses two dicts instead, and also wrap the code in a separate function
data_format_code
, because the function will also be used inFigure.coupe()
(not wrapped yet).I also add several doctests to check the function and increase the code coverage.
References: https://docs.generic-mapping-tools.org/latest/supplements/seis/meca.html#s
Fixes #
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