Stream.rotate('->ZNE', components=...): be nice on slightly unexpected input #2082
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.
see
http://lists.swapbytes.de/archives/obspy-users/2018-March/002692.html
What does this PR do?
Make
Stream.rotate('->ZNE', ...)
acceptcomponents
that is a string of component codes (as opposed to a list of strings). Although it's clear from the docstring what is expected, I think the likelihood of people misusing this parameter are high enough that we should work around it. A warning is also shown on invalid input before it is converted.Why was it initiated? Any relevant Issues?
Report on users mailing list, see http://lists.swapbytes.de/archives/obspy-users/2018-March/002692.html
PR Checklist
master
for new fetures,maintenance_...
for bug fixesIf the PR is making changes to documentation, docs pages can be built automatically.no docs changeJust remove the space in the following string after the + sign: "+ DOCS"
If any network modules should be tested for the PR, add them as a comma separated listno network tests(e.g.
clients.fdsn,clients.arclink
) after the colon in the following magic string: "+TESTS:"(you can also add "ALL" to just simply run all tests across all modules)
Any new features or fixed regressions are be covered via new tests.no new featuresAny new or changed features have are fully documented.no new featuresCHANGELOG.txt
.First time contributors have added your name toCONTRIBUTORS.txt
.