Skip to content
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

DOC: Update from_records docstring to not mention DataFrame as valid input #60310

Merged
merged 2 commits into from
Nov 14, 2024
Merged

DOC: Update from_records docstring to not mention DataFrame as valid input #60310

merged 2 commits into from
Nov 14, 2024

Conversation

U-S-jun
Copy link
Contributor

@U-S-jun U-S-jun commented Nov 14, 2024

Removed mention of DataFrame as an acceptable input type, as it is no longer supported
`
Convert structured or record ndarray to DataFrame.

    Creates a DataFrame object from a structured ndarray, sequence of
    tuples or dicts.

`

Ensured compatibility with numpydoc format by validating against validate_docstrings.py

@jorisvandenbossche jorisvandenbossche changed the title DOC: Update from_records docstring(GH#60307) DOC: Update from_records docstring to not mention DataFrame as valid input Nov 14, 2024
jorisvandenbossche
jorisvandenbossche reviewed Nov 14, 2024
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.

Thanks or the PR!

Just a small grammatical comment

pandas/core/frame.py Outdated Show resolved Hide resolved
@jorisvandenbossche jorisvandenbossche added this to the 3.0 milestone Nov 14, 2024
@U-S-jun @jorisvandenbossche
Update pandas/core/frame.py
cbf06a2 
Added "or" before the last item in the enumeration for improved clarity in the from_records docstring.

Co-authored-by: Joris Van den Bossche <[email protected]>
@mroeschke mroeschke merged commit 9bee2f0 into pandas-dev:main Nov 14, 2024
51 checks passed
@mroeschke
Copy link
Member

Thanks @U-S-jun

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

@mroeschke mroeschke mroeschke approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
3.0
Development

Successfully merging this pull request may close these issues.

DOC: Dataframe.from_records should not say that passing in a DataFrame for data is allowed
3 participants
@U-S-jun @mroeschke @jorisvandenbossche