GH-37222: [Docs][MATLAB] Rename arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase)#37223
Merged
kevingurney merged 1 commit intoapache:mainfrom Aug 17, 2023
Merged
Conversation
Co-authored-by: Sarah Gilmore <[email protected]>
github-actions
bot
added
Component: MATLAB
Component: Documentation
awaiting committer review
sgilmore10
approved these changes
Aug 17, 2023
Member
sgilmore10
left a comment
sgilmore10
left a comment
There was a problem hiding this comment.
No flags. Thanks for doing this!
kevingurney
changed the title
arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase)arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase)
Member
Author
|
+1 |
|
After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit e44f5eb. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
loicalleyne
pushed a commit
to loicalleyne/arrow
that referenced
this pull request
Nov 13, 2023
…ase) to `arrow.recordBatch` (camelCase) (apache#37223) ### Rationale for this change As @ kou suggested in apache#37215 (comment), it makes sense to rename `arrow.recordbatch` (all lowercase) to `arrow.recordBatch` (camelCase). `recordBatch` is the first "two-word" function in the top-level `arrow.*` package, so it makes sense to establish a clear camelCase standard for "multi-word" functions in the MATLAB interface at this point. One part of the rationale motivating this change is that other language bindings follow a similar pattern (e.g. `pyarrow.record_batch` instead of `pyarrow.recordbatch`). ### What changes are included in this PR? 1. Renamed `arrow.recordbatch` (all lowercase) to `arrow.recordBatch` (camelCase). 2. Updated documentation and tests to reflect `arrow.recordbatch` being renamed to `arrow.recordBatch`. ### Are these changes tested? Yes. 1. All existing MATLAB tests have been updated to use the new name `arrow.recordbatch` and are passing on my Debian 11 machine. ### Are there any user-facing changes? Yes. **This PR includes breaking changes to public APIs.** The public facing API `arrow.recordbatch` has been renamed to `arrow.recordBatch`. Since the MATLAB interface is still "pre 1.0", we don't expect this change to have a significant impact. ### Notes 1. Thank you @ sgilmore10 for your help with this pull request! * Closes: apache#37222 Lead-authored-by: Kevin Gurney <[email protected]> Co-authored-by: Sarah Gilmore <[email protected]> Signed-off-by: Kevin Gurney <[email protected]>
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
2 participants
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.
Rationale for this change
As @kou suggested in #37215 (comment), it makes sense to rename
arrow.recordbatch(all lowercase) toarrow.recordBatch(camelCase).recordBatchis the first "two-word" function in the top-levelarrow.*package, so it makes sense to establish a clear camelCase standard for "multi-word" functions in the MATLAB interface at this point.One part of the rationale motivating this change is that other language bindings follow a similar pattern (e.g.
pyarrow.record_batchinstead ofpyarrow.recordbatch).What changes are included in this PR?
arrow.recordbatch(all lowercase) toarrow.recordBatch(camelCase).arrow.recordbatchbeing renamed toarrow.recordBatch.Are these changes tested?
Yes.
arrow.recordbatchand are passing on my Debian 11 machine.Are there any user-facing changes?
Yes.
This PR includes breaking changes to public APIs.
The public facing API
arrow.recordbatchhas been renamed toarrow.recordBatch. Since the MATLAB interface is still "pre 1.0", we don't expect this change to have a significant impact.Notes
arrow.recordbatch(all lowercase) toarrow.recordBatch(camelCase) #37222