Skip to content

DOC: Additions/updates to documentation GH47282 #47283

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
wants to merge 2 commits into from

Conversation

Capobiaj
Copy link

@Capobiaj Capobiaj commented Jun 8, 2022

@@ -21,6 +21,14 @@ Object creation

See the :ref:`Intro to data structures section <dsintro>`.

:class:`Series` is a one-dimensional labeled array capable of holding any
Copy link
Member

Choose a reason for hiding this comment

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

I suggest changing capable of holding any data type with of a singular data type (integer, string, float, etc).

"any data type" is somewhat misleading since some unsupported data types get coerced to object

data type (integers, strings, floating point numbers, Python objects, etc.).

:class:`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
Copy link
Member

Choose a reason for hiding this comment

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

To keep this succinct, I would remove the detail regarding what a DataFrame can accept (Like Series, DataFrame accepts ....). This information should be demo'd below along in the hyperlink created by :class:`Dataframe`

@jreback jreback added the Docs label Jun 10, 2022
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

@Capobiaj do you have time to address the comments?

@@ -21,6 +21,14 @@ Object creation

See the :ref:`Intro to data structures section <dsintro>`.
Copy link
Member

Choose a reason for hiding this comment

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

This page contains a detailed explanation of what you're adding here. Probably better to have this after what you're writing, with something like For more details about Series and DataFrame, see the intro to data structures section.

@github-actions
Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Jul 17, 2022
@datapythonista
Copy link
Member

Closing as stale. @Capobiaj if you want to address the comments and continue working on this, please let us know to reopen.

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

Successfully merging this pull request may close these issues.

DOC: 10 Minutes Guide has assumed knowledge on new users
4 participants