Skip to content

DOC: 10 Minutes Guide has assumed knowledge on new users #47282

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
1 task done
Capobiaj opened this issue Jun 8, 2022 · 4 comments · Fixed by #54010
Closed
1 task done

DOC: 10 Minutes Guide has assumed knowledge on new users #47282

Capobiaj opened this issue Jun 8, 2022 · 4 comments · Fixed by #54010

Comments

@Capobiaj
Copy link

Capobiaj commented Jun 8, 2022

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/user_guide/10min.html#min

Documentation problem

The 10 minutes guide has assumed knowledge on the part of the user regarding what exactly a 'Series' or 'DataFrame' are. The linked material is too complex for a 10 minute guide designed for new users to the project.

Being that the 10 minutes to pandas guide was designed for new users to quickly get an introduction to the project and orient themselves to learn and use the project, a brief explanation of what those two data structures are would be beneficial to new users and help them better acclimate, adjust, and understand the project and its use cases.

Suggested fix for documentation

The 10 minute guide could benefit from a very brief (1-2 sentences) explanation of what Series and DataFrames to aid new users.

Suggested fix in the documentation is: transposing part of 'Intro to data structures' definition of Series and DataFrame onto 10min.rst.

Suggest Series definition addition to documentation:

Series is a one-dimensional labeled array capable of holding any data type (integers, strings, floating point numbers, Python objects, etc.).

Suggested DataFrame definition addition to documentation:

DataFrame is a 2-dimensional labeled data structure with columns of potentially different types. You can think of it like a spreadsheet or SQL table, or a dict of Series objects. Like Series, DataFrame accepts many different kinds of input such as: Dicts of 1D ndarrays lists, dicts or series, along with 2-D numpy.ndarray, Structured or record ndarray, and another DataFrame.

@Capobiaj Capobiaj added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 8, 2022
@Capobiaj
Copy link
Author

Capobiaj commented Jun 8, 2022

take

@topper-123
Copy link
Contributor

I just looked at the 10min intro, and I agree very short text intro to series/dataframes would be good. I think it could ve eveb shorter than you propose through (new users may not know what numpy.ndarray, Structured or record ndarrays are, for example.

@topper-123 topper-123 added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Mar 22, 2023
@aadeshmodak13
Copy link

take

1 similar comment
@rsm-23
Copy link
Contributor

rsm-23 commented Jul 5, 2023

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment