Skip to content

Commit b034f45

Browse files
Reranko05Reranko05
authored
MINOR: [Docs][MATLAB][Python] Fixed three minor issues (#51379)
### Rationale for this change Fix three minor issues as discussed in #51358 (comment) ### What changes are included in this PR? - Fix the punctuation in title-check comment. - Remove an extra parenthesis from the `pyrunfile` link in the MATLAB documentation. - Fix the `buffers` parameter name in the `buffers_to_array` documentation. ### Are these changes tested? These are minor documentation fixes. ### Are there any user-facing changes? Yes. ### Was AI used for this PR? In accordance to the [AI generation guidelines](https://arrow.apache.org/docs/dev/developers/overview.html#ai-generated-code), please disclose below whether and how AI was used in this PR. **PR code and description written by:** - [X] Human - [ ] AI **Reviewed before submission by:** - [X] Human - [ ] AI - [ ] Not reviewed Authored-by: Aaditya Srinivasan <aadityasri03@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
1 parent 66e450c commit b034f45

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎.github/workflows/dev_pr/title_check.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Thanks for opening a pull request!
2121

2222
**This pull request has been automatically converted to a draft because its title doesn't match Arrow's required format.**
2323

24-
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
24+
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes), could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
2525

2626
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
2727

‎matlab/doc/matlab_interface_for_apache_arrow_design.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ To share a MATLAB `arrow.Array` with PyArrow efficiently, a user could use the `
179179

180180
Memory addresses for the `ArrowArray` and `ArrowSchema` structs are returned by the call to `export`. These addresses can be passed to Python directly, without having to make any copies of the underlying Arrow data structures that they refer to. A user can then wrap the underlying data pointed to by the `ArrowArray` struct (which is already in the [Arrow Columnar Format]), as well as extract the necessary metadata from the `ArrowSchema` struct, to create a `pyarrow.Array` by using the static method `pyarrow.Array._import_from_c`.
181181

182-
Multiple lines of Python are required to import the Arrow array from MATLAB. Therefore, the function [`pyrunfile`]((https://www.mathworks.com/help/matlab/ref/pyrunfile.html)) can be used which can run Python scripts defined in an external file.
182+
Multiple lines of Python are required to import the Arrow array from MATLAB. Therefore, the function [`pyrunfile`](https://www.mathworks.com/help/matlab/ref/pyrunfile.html) can be used which can run Python scripts defined in an external file.
183183

184184
###### Example Code:
185185

‎python/pyarrow/interchange/from_dataframe.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ def buffers_to_array(
330330
331331
Parameters
332332
----------
333-
buffer : ColumnBuffers
333+
buffers : ColumnBuffers
334334
Dictionary containing tuples of underlying buffers and
335335
their associated dtype.
336336
data_type : Tuple[DtypeKind, int, str, str],

0 commit comments

Comments
 (0)