Skip to content

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

Closed
amol- wants to merge 8 commits into
apache:masterfrom
amol-:ARROW-13404
Closed

ARROW-13404: [Doc][Python] Improve PyArrow documentation for new users#10999
amol- wants to merge 8 commits into
apache:masterfrom
amol-:ARROW-13404

Conversation

@amol-

@amol-amol- commented Aug 25, 2021

Copy link
Copy Markdown
Member
  • 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

github-actionsBot commented Aug 25, 2021

Copy link
Copy Markdown

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

@amol-

amol- commented Aug 27, 2021

Copy link
Copy Markdown
MemberAuthor

@jorisvandenbossche mind taking a look?

jorisvandenbossche
jorisvandenbossche reviewed Aug 30, 2021
View reviewed changes

@jorisvandenbosschejorisvandenbossche left a comment

Copy link
Copy Markdown
Member

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).

Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/index.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
Comment threaddocs/source/python/getstarted.rst Outdated
amol-and others added 3 commits August 30, 2021 12:01
@amol-@jorisvandenbossche
Apply suggestions from code review
a534f37
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@amol-
Address feedback
c59d08c
@amol-
provide link names
a6ca944
@amol-

amol- commented Aug 30, 2021

Copy link
Copy Markdown
MemberAuthor

@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
Comment threaddocs/source/python/getstarted.rst Outdated
pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes
Comment threaddocs/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`).

@pitroupitrouAug 31, 2021

Copy link
Copy Markdown
Member

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 :-)

@amol-amol-Sep 1, 2021

Copy link
Copy Markdown
MemberAuthor

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
Comment threaddocs/source/python/getstarted.rst Outdated
pitrou
pitrou reviewed Aug 31, 2021
View reviewed changes

@pitroupitrou left a comment

Copy link
Copy Markdown
Member

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 :-)

@pitroupitrou closed this in 3da09e5Sep 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
Closesapache#10999 from amol-/ARROW-13404
Authored-by: Alessandro Molina <amol@turbogears.org>
Signed-off-by: Antoine Pitrou <antoine@python.org>
@asfimportasfimport mentioned this pull request Sep 1, 2021
Closed
@eitsupieitsupi 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#5198ARROW-6364#5201ARROW-6323#5169ARROW-6278#5141ARROW-6360#5329ARROW-6533#5450ARROW-6348#5223ARROW-6337#5399ARROW-10850#9128ARROW-10624#9092ARROW-10386#8549ARROW-6994#23308ARROW-12774#10320ARROW-12670#10287ARROW-16828#13484ARROW-14989#13482ARROW-16977#13514ARROW-13404#10999ARROW-16887#13601ARROW-15906#13206ARROW-15280#13171ARROW-16144#13183ARROW-16511#13105ARROW-16085#13088ARROW-16715#13555ARROW-16268#13550ARROW-16700#13518ARROW-16807#13583ARROW-16871#13517ARROW-16415#13190ARROW-14821#12154ARROW-16439#13174ARROW-16394#13118ARROW-16516#13163ARROW-16395#13627ARROW-14848#12589ARROW-16407#13196ARROW-16653#13506ARROW-14575#13160ARROW-15271#13170ARROW-16703#13650ARROW-16444#13397ARROW-15016#13541ARROW-16776#13563ARROW-15622#13090ARROW-18131#14484ARROW-18305#14581ARROW-18285#14615
* Closes: #33631
Authored-by: SHIMA Tatsuya <ts1s1andn@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jorisvandenbosschejorisvandenbosschejorisvandenbossche left review comments
@pitroupitroupitrou 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