Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs][MATLAB] Rename arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase) #37222

Closed
kevingurney opened this issue Aug 17, 2023 · 1 comment · Fixed by #37223
Closed

[Docs][MATLAB] Rename arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase) #37222

kevingurney opened this issue Aug 17, 2023 · 1 comment · Fixed by #37223
Assignees
@kevingurney
Labels
Component: Documentation Component: MATLAB Type: enhancement
Milestone
14.0.0

Comments

@kevingurney
Copy link
Member

Describe the enhancement requested

As @kou suggested in #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).

Component(s)

MATLAB
@kevingurney kevingurney self-assigned this Aug 17, 2023
@kevingurney kevingurney mentioned this issue Aug 17, 2023
Merged
@github-actions github-actions bot mentioned this issue Aug 17, 2023
Merged
@kevingurney kevingurney changed the title [MATLAB] Rename arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase) [Docs][MATLAB] Rename arrow.recordbatch (all lowercase) to arrow.recordBatch (camelCase) Aug 17, 2023
@kevingurney
Copy link
Member Author

Added label Component: documentation since making this change requires updating the MATLAB README.md to reflect arrow.recordbatch being renamed to arrow.recordBatch.

kevingurney added a commit that referenced this issue Aug 17, 2023
@kevingurney @sgilmore10
GH-37222: [Docs][MATLAB] Rename arrow.recordbatch (all lowercase) t…
e44f5eb 
…o `arrow.recordBatch` (camelCase) (#37223)

### Rationale for this change

As @ kou suggested in #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: #37222

Lead-authored-by: Kevin Gurney <[email protected]>
Co-authored-by: Sarah Gilmore <[email protected]>
Signed-off-by: Kevin Gurney <[email protected]>
@kevingurney kevingurney added this to the 14.0.0 milestone Aug 17, 2023
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@kevingurney @sgilmore10 @loicalleyne
apacheGH-37222: [Docs][MATLAB] Rename arrow.recordbatch (all lowerc…
5aaeb68 
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kevingurney kevingurney

Labels
Component: Documentation Component: MATLAB Type: enhancement
Projects
None yet
Milestone
14.0.0
1 participant
@kevingurney