fix(smoothing_length): require positional arguments before / - #339
Open
KTQ0912 wants to merge 1 commit into
Open
fix(smoothing_length): require positional arguments before /#339KTQ0912 wants to merge 1 commit into
KTQ0912 wants to merge 1 commit into
Conversation
- Prevents confusing cryptic errors when users pass coordinates/boxsize as keyword arguments to generate_smoothing_lengths. - Matches issue suggestion to mark early parameters as positional. Fixes SWIFTSIM#234
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #234
What changed
coordinates,boxsize,kernel_gamma,neighbours,speedup_facas positional-only ingenerate_smoothing_lengths.Why
coordinates=...as a keyword confused_propagate_cosmo_array_attributes_to_result, because the decorator copies attributes from the first positional argument.TypeErrorinstead of the cryptic missing-argument error from the decorator.Risk
TypeError. These inputs are almost always passed positionally in existing code/tests.