refactor: removed the 'ak._util.extra' argument helper. #1955
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
agoose77
reviewed
Dec 6, 2022
Comment on lines
+25
to
+33
| broadcast_parameters_rule (str): Rule for broadcasting parameters, one of: | ||
| - `"intersect"` | ||
| - `"all_or_nothing"` | ||
| - `"one_to_one"` | ||
| - `"none"` | ||
| left_broadcast (bool): If True, follow rules for implicit | ||
| left-broadcasting, as described below. | ||
| right_broadcast (bool): If True, follow rules for implicit | ||
| right-broadcasting, as described below. |
There was a problem hiding this comment.
I swear we had this at one point. Maybe it never made it to the final PR 😦
agoose77
approved these changes
Dec 6, 2022
Codecov Report
Additional details and impacted files
|
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.
It was a vestige of Python 2: as you can see, we can express the keyword-only arguments after a
*arrayswithout any trouble in Python 3. This is relevant because the documentation will be generated with more information now—these extra arguments and their defaults will appear in the HTML rendering of the function signatures.Also,
ak.broadcast_arrayswas missing information about itsbroadcast_parameters_ruleargument. Presumably, that was an oversight? (And it demonstrates the problem withak._util.extra.)📚 The documentation for this PR will be available at https://awkward-array.readthedocs.io/en/jpivarski-remove-extra-argument-helper/ once Read the Docs has finished building 🔨