CHG: Capture explicit default settings if also in cfg
#284
Conversation
This file contains 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
- if the user sets a default value explicitly, e.i. `keeptrials=True`,
but `keeptrials` also appears in a provided `cfg` structure, raise a
`SPYValueError`
- both `cfg` and explicit keywords are allowed, as long as they are
mutually exclusive, e.i. `func(data, cfg={'pad' : 3},
keeptrials=False)` is valid
- minor fix: `'pad'` kw added to valid kws for MultiTaperFFT
On branch issue-278
Your branch is up to date with 'origin/dev'.
Changes to be committed:
modified: syncopy/shared/kwarg_decorators.py
modified: syncopy/specest/compRoutines.py
- the general check for duplicated parameter settings cfg/kw is not needed for 'data'/'dataset' as those get special treatment anyways On branch issue-278 Your branch is ahead of 'origin/dev' by 1 commit. (use "git push" to publish your local commits) Changes to be committed: modified: syncopy/shared/kwarg_decorators.py modified: syncopy/tests/test_decorators.py
Codecov Report
@@ Coverage Diff @@
## dev #284 +/- ##
==========================================
+ Coverage 68.19% 68.43% +0.23%
==========================================
Files 67 67
Lines 7630 7634 +4
Branches 1581 1582 +1
==========================================
+ Hits 5203 5224 +21
+ Misses 2067 2054 -13
+ Partials 360 356 -4
Continue to review full report at Codecov.
|
pantaray
approved these changes
May 25, 2022
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.
keeptrials=True,but
keeptrialsalso appears in a providedcfgstructure, raise aSPYValueErrorcfgand explicit keywords are allowed, as long as they aremutually exclusive, e.i.
func(data, cfg={'pad' : 3}, keeptrials=False)is valid'pad'kw added to valid kws for MultiTaperFFTOn branch issue-278
Your branch is up to date with 'origin/dev'.
Changes to be committed:
modified: syncopy/shared/kwarg_decorators.py
modified: syncopy/specest/compRoutines.py
closes #278
Author Guidelines
Reviewer Checklist