Skip to content

DOC: fix grammar issues and incorrect link in "Getting Started" guide #40215

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

Closed
madhuv2002 opened this issue Mar 4, 2021 · 2 comments · Fixed by #40290
Closed

DOC: fix grammar issues and incorrect link in "Getting Started" guide #40215

madhuv2002 opened this issue Mar 4, 2021 · 2 comments · Fixed by #40290
Assignees
Labels
Milestone

Comments

@madhuv2002
Copy link

Location of the documentation

https://pandas.pydata.org/docs/getting_started/index.html

Documentation problem

As part of the HackIllinois Open Source Fellowship and having never used pandas before, I have been reading through the pandas documentation to learn more about it and noticed several issues in the Getting Started page of the docs.

  • Small punctuation errors
  • The "to user guide" link under "How to manipulate textual data?" leads to the time-series section of the guide
  • Under "How to combine data from multiple tables", the given explanation is hard to understand due to grammar issues

Suggested fix for documentation

  • Under "What kind of data does pandas handle" add a comma after "clean"
  • Under "How to calculate summary statistics" add a comma after "a sliding window of data"
  • For the incorrect linking to time-series, have the user guide instead link to "Working with text data"
  • Rephrase the synopsis under "How to combine data from multiple tables" to -> Multiple tables can be concatenated both column wise and row wise as database-like join/merge operations are provided to combine multiple tables of data.
@madhuv2002 madhuv2002 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 4, 2021
@lithomas1 lithomas1 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Mar 4, 2021
@lithomas1 lithomas1 added this to the Contributions Welcome milestone Mar 4, 2021
@rlukevie
Copy link
Contributor

rlukevie commented Mar 5, 2021

take

@afeld
Copy link
Member

afeld commented Mar 13, 2021

Yay! Another contribution for #39349.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants