-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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.
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
MINOR: [Python][Docs] Add examples for MapArray.from_arrays
#37656
MINOR: [Python][Docs] Add examples for MapArray.from_arrays
#37656
Conversation
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format?
or
In the case of PARQUET issues on JIRA the title also supports:
See also: |
18cd687
to
e925b6c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great example! I left a few small comments, let me know what you think. I thought it might be clearer to explicitly state that the numpy representation is there to visualize the data that we will put in the MapArray.
I accepted both of your changes. Thanks so much. I'm glad you find the example useful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last few comments. After that LGTM! I added a committer for final review.
Could you read the auto generated comment? |
5602b85
to
9bfd081
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @slobodan-ilic and thank you for this great example!
Adding a suggestion to fix the doctest error.
We should also add an issue for the PR to be linked to, as Kou already mentioned.
@AlenkaF I was thinking about adding MINOR: [Python] Add examples for MapArray.from_arrays rather than creating an issue, since I believe it's a minor PR (as per second part of the autogenerated comment that @kou referenced). But if you say the issue creation is the way to go forward, please lmk and I'll do so. |
MapArray.from_arrays
Yes of course, that is totally fine 👍 |
0c11829
to
d02059e
Compare
Thanks for the contribution @slobodan-ilic ! |
Hi @raulcd! Long time no see ❤️ |
@AlenkaF I'm seeing some failures in the |
It seems to be failing on main as seen here: https://ci.appveyor.com/project/ApacheSoftwareFoundation/arrow/builds/48012043 |
There is already an open PR to fix this issue #37558 so you can ignore this failing build. |
I'm fine leaving it the way it is! I do agree the example is more relateable this way. |
d02059e
to
8b7d800
Compare
8b7d800
to
fd68a1e
Compare
Added one last suggestion, otherwise LGTM! |
Co-authored-by: Dane Pitkin <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
1630b82
to
735bb49
Compare
Addressed. 💯 |
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for you contribution @slobodan-ilic!
After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 28266f1. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them. |
…#37656) ### Rationale for this change This PR enriched the `MapArray.from_arrays` with some nice examples. The examples are from the real-world scenario of working with survey data (scaled down, of course). ### What changes are included in this PR? The only change that this PR presents is to the docstring of the `MapArray.from_arrays` function. ### Are these changes tested? Does not apply ### Are there any user-facing changes? Yes, the docstring of the `MapArray.from_arrays` function. Lead-authored-by: Slobodan Ilic <[email protected]> Co-authored-by: Slobodan Ilic <[email protected]> Co-authored-by: Alenka Frim <[email protected]> Co-authored-by: Dane Pitkin <[email protected]> Signed-off-by: AlenkaF <[email protected]>
…#37656) ### Rationale for this change This PR enriched the `MapArray.from_arrays` with some nice examples. The examples are from the real-world scenario of working with survey data (scaled down, of course). ### What changes are included in this PR? The only change that this PR presents is to the docstring of the `MapArray.from_arrays` function. ### Are these changes tested? Does not apply ### Are there any user-facing changes? Yes, the docstring of the `MapArray.from_arrays` function. Lead-authored-by: Slobodan Ilic <[email protected]> Co-authored-by: Slobodan Ilic <[email protected]> Co-authored-by: Alenka Frim <[email protected]> Co-authored-by: Dane Pitkin <[email protected]> Signed-off-by: AlenkaF <[email protected]>
Rationale for this change
This PR enriched the
MapArray.from_arrays
with some nice examples. The examples are from the real-world scenario of working with survey data (scaled down, of course).What changes are included in this PR?
The only change that this PR presents is to the docstring of the
MapArray.from_arrays
function.Are these changes tested?
Does not apply
Are there any user-facing changes?
Yes, the docstring of the
MapArray.from_arrays
function.