REFACTOR-#5425: Unify internal usage of axis parameter and named kwargs #5427
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.
Signed-off-by: Jonathan Shi [email protected]
What do these changes do?
This makes the internal usage of the "axis" keyword argument more consistent, and forces callers of most dataframe/partition manager apply and broadcast methods to name keyword arguments in most situation, to avoid possible confusion and subtle bugs from when argument orders are mistakenly swapped.
The new orders are as follows:
Dataframe:
apply_*(func, axis, ... [other kwargs])
Partition manager:
apply_*(partitions, func, axis, ... [other kwargs])
The rationale for placing func in front of axis is to more closely align with the way non-axis apply methods (like
modin_dataframe.map
are called.flake8 modin/ asv_bench/benchmarks scripts/doc_checker.py
black --check modin/ asv_bench/benchmarks scripts/doc_checker.py
git commit -s
docs/development/architecture.rst
is up-to-date