Skip to content

ARROW-13404: [Doc][Python] Improve PyArrow documentation for new users #10999

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
Closed
amol- wants to merge 8 commits into from
Closed

ARROW-13404: [Doc][Python] Improve PyArrow documentation for new users #10999

amol- wants to merge 8 commits into from

Conversation

@amol-
Copy link
Member

@amol- amol- commented Aug 25, 2021

  • Add link to the cookbooks
  • Improve a bit landing page for PyArrow for people that don't already know Arrow
  • Add a Getting Started section to introduce people to Arrow and PyArrow

@github-actions
Copy link

github-actions bot commented Aug 25, 2021

https://issues.apache.org/jira/browse/ARROW-13404

@amol-
Copy link
Member Author

amol- commented Aug 27, 2021

@jorisvandenbossche mind taking a look?

jorisvandenbossche
jorisvandenbossche reviewed Aug 30, 2021
View reviewed changes
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amol- Thanks! That's a nice high-level overview of the pyarrow library, that's indeed a very welcome addition! I added a bunch of comments (mostly minor, on wording etc).

@amol-
Copy link
Member Author

amol- commented Aug 30, 2021

@jorisvandenbossche I think this should have addressed all your concerns and should be ready to go

pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes
pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes
docs/source/python/getstarted.rst

Arrow also provides support for various formats to get those tabular
data in and out of disk and networks. Most commonly used formats are
Parquet (:ref:`parquet`) and the IPC format (:ref:`ipc`).
Copy link
Member

@pitrou pitrou Aug 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the IPC format is really commonly used compared to, say, CSV :-)

Copy link
Member Author

@amol- amol- Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I mentioned the formats that are column major. As CSV and JSON are row oriented I didn't mentioned them as primary choices, but they are mentioned in the "Saving and Loading Tables" section together with the other available formats.

pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes
pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes
Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good on the principle, I posted a small number of comments separately :-)

@pitrou pitrou closed this in 3da09e5 Sep 1, 2021
ViniciusSouzaRoque pushed a commit to s1mbi0se/arrow that referenced this pull request Oct 20, 2021
@amol- @ViniciusSouzaRoque
ARROW-13404: [Doc][Python] Improve PyArrow documentation for new users
8f96818 
* Add link to the cookbooks
* Improve a bit landing page for PyArrow for people that don't already know Arrow
* Add a Getting Started section to introduce people to Arrow and PyArrow

Closes apache#10999 from amol-/ARROW-13404

Authored-by: Alessandro Molina <[email protected]>
Signed-off-by: Antoine Pitrou <[email protected]>
@asfimport asfimport mentioned this pull request Sep 1, 2021
Closed
@eitsupi eitsupi mentioned this pull request Feb 19, 2023
Merged
kou pushed a commit that referenced this pull request Feb 20, 2023
@eitsupi
GH-33631: [R] Rewrite Jira ticket numbers in pkgdown documents to Git…
be40d9f 
…Hub issue numbers (#34260)

Rewrite the Jira issue numbers to the GitHub issue numbers, so that the GitHub issue numbers are automatically linked to the issues by pkgdown's auto-linking feature.

Issue numbers have been rewritten based on the following correspondence.
Also, the pkgdown settings have been changed and updated to link to GitHub.

I generated the Changelog page using the `pkgdown::build_news()` function and verified that the links work correctly.

---
ARROW-6338	#5198
ARROW-6364	#5201
ARROW-6323	#5169
ARROW-6278	#5141
ARROW-6360	#5329
ARROW-6533	#5450
ARROW-6348	#5223
ARROW-6337	#5399
ARROW-10850	#9128
ARROW-10624	#9092
ARROW-10386	#8549
ARROW-6994	#23308
ARROW-12774	#10320
ARROW-12670	#10287
ARROW-16828	#13484
ARROW-14989	#13482
ARROW-16977	#13514
ARROW-13404	#10999
ARROW-16887	#13601
ARROW-15906	#13206
ARROW-15280	#13171
ARROW-16144	#13183
ARROW-16511	#13105
ARROW-16085	#13088
ARROW-16715	#13555
ARROW-16268	#13550
ARROW-16700	#13518
ARROW-16807	#13583
ARROW-16871	#13517
ARROW-16415	#13190
ARROW-14821	#12154
ARROW-16439	#13174
ARROW-16394	#13118
ARROW-16516	#13163
ARROW-16395	#13627
ARROW-14848	#12589
ARROW-16407	#13196
ARROW-16653	#13506
ARROW-14575	#13160
ARROW-15271	#13170
ARROW-16703	#13650
ARROW-16444	#13397
ARROW-15016	#13541
ARROW-16776	#13563
ARROW-15622	#13090
ARROW-18131	#14484
ARROW-18305	#14581
ARROW-18285	#14615
* Closes: #33631

Authored-by: SHIMA Tatsuya <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche left review comments

@pitrou pitrou pitrou approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@amol- @jorisvandenbossche @pitrou