Skip to content

DOC: Add none as a default argument for orient #48281

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
Merged
merged 5 commits into from
Sep 4, 2022
Merged

DOC: Add none as a default argument for orient #48281

merged 5 commits into from
Sep 4, 2022

Conversation

ambujpawar
Copy link
Contributor

@ambujpawar ambujpawar commented Aug 27, 2022 •
edited
Loading

Add None as an acceptable argument for orient in read_json over here

phofl
phofl requested changes Aug 27, 2022
View reviewed changes
Copy link
Member

@phofl phofl left a comment

Choose a reason for hiding this comment

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

Can you add what None does and if it is allowed for typ=series or typ=frame?

@ambujpawar ambujpawar changed the title Add none as a default argument for orient DOC: Add none as a default argument for orient Aug 28, 2022
@ambujpawar
Copy link
Contributor Author

Based on my understanding, None does nothing. It is just an acceptable value.
The value of 'orient' depends on the value of "typ" parameter as mentioned later in the docstring over here:

The allowed and default values depend on the value of the typ parameter.

For Series: default is index and For Frame: default is columns

Since, it is already mentioned, I am not quite sure how shall I improve it. Shall I change the default value of it being 'columns' instead of None since the default value of 'typ' is 'Series'?

@mroeschke mroeschke added Docs IO JSON read_json, to_json, json_normalize labels Aug 29, 2022
datapythonista
datapythonista reviewed Sep 1, 2022
View reviewed changes
@ambujpawar ambujpawar requested review from phofl and datapythonista and removed request for phofl and datapythonista September 3, 2022 04:19
datapythonista
datapythonista approved these changes Sep 3, 2022
View reviewed changes
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.

Thanks @ambujpawar

@ambujpawar ambujpawar requested a review from phofl September 4, 2022 04:53
@phofl phofl added this to the 1.6 milestone Sep 4, 2022
@phofl phofl merged commit ddf2541 into pandas-dev:main Sep 4, 2022
@phofl
Copy link
Member

phofl commented Sep 4, 2022

thx @ambujpawar

@mroeschke mroeschke removed this from the 1.6 milestone Oct 13, 2022
@mroeschke mroeschke added this to the 2.0 milestone Oct 13, 2022
@ambujpawar ambujpawar deleted the 48252_improve_documentation_read_json branch October 16, 2022 18:43
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
@ambujpawar @noatamir
DOC: Add none as a default argument for orient (pandas-dev#48281)
2f68661
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

@phofl phofl phofl approved these changes

Assignees
No one assigned
Labels
Docs IO JSON read_json, to_json, json_normalize
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.

DOC: read_json should list None for orient
4 participants
@ambujpawar @phofl @datapythonista @mroeschke