Skip to content

DOC: fix a failing doctest in DataFrame.to_dict #22827

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

Merged
merged 10 commits into from
Oct 15, 2018
Merged

DOC: fix a failing doctest in DataFrame.to_dict #22827

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ecdd114
DOC: fix a failing doctest in DataFrame.to_dict
Sep 25, 2018
42b3288
Merge branch 'master' into docstring_dataframe_to_dict
Moisan Sep 26, 2018
fe9be1d
Add a better example
Sep 26, 2018
5438849
Merge branch 'docstring_dataframe_to_dict' of github.com:Moisan/panda…
Sep 26, 2018
0ba11ca
Add dict and list to the returned types
Sep 28, 2018
db130ae
Revert to row/col example
Sep 28, 2018
4831174
Use 'row1' and 'row2' insteaf of 'a' and 'b'
Sep 29, 2018
e11abb1
Add a complete description in the Returns section
Sep 29, 2018
2ecfb6c
Merge branch 'master' into docstring_dataframe_to_dict
Oct 15, 2018
64f6050
Update CI to check pandas.DataFrame.to_dict doctests
Oct 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ci/doctests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if [ "$DOCTEST" ]; then

# DataFrame / Series docstrings
pytest --doctest-modules -v pandas/core/frame.py \
-k"-axes -combine -isin -itertuples -join -nlargest -nsmallest -nunique -pivot_table -quantile -query -reindex -reindex_axis -replace -round -set_index -stack -to_dict -to_stata"
-k"-axes -combine -isin -itertuples -join -nlargest -nsmallest -nunique -pivot_table -quantile -query -reindex -reindex_axis -replace -round -set_index -stack -to_stata"

if [ $? -ne "0" ]; then
RET=1
Expand Down
5 changes: 3 additions & 2 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1085,7 +1085,8 @@ def to_dict(self, orient='dict', into=dict):

Returns
-------
result : collections.Mapping like {column -> {index -> value}}
collections.Mapping
like {column -> {index -> value}}
Copy link
Member

Choose a reason for hiding this comment

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

Sorry to ask you one more change. Do you mind changing the description of the Returns to something more accurate? That is only true with the default orient. Also, it'd be nice to start it with a capital letter and end it with a period. Thanks!

Copy link
Contributor Author

@Moisan Moisan Sep 29, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

No problem, better make it right during this pull request than having to come back later!


See Also
--------
Expand Down Expand Up @@ -1122,7 +1123,7 @@ def to_dict(self, orient='dict', into=dict):
[{'col1': 1.0, 'col2': 0.5}, {'col1': 2.0, 'col2': 0.75}]

>>> df.to_dict('index')
{'a': {'col1': 1.0, 'col2': 0.5}, 'b': {'col1': 2.0, 'col2': 0.75}}
{'a': {'col1': 1, 'col2': 0.5}, 'b': {'col1': 2, 'col2': 0.75}}
Copy link
Member

Choose a reason for hiding this comment

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

I'm ok merging this and just making the tests pass, but if you want to take care here of making the examples easier to understand, I think it'd be good as in the other strings to use real-world (e.g. animal legs...) examples.

From this, it takes a bit to see what's a, 1... Using something meaningful would be immediate.

Copy link
Member

Choose a reason for hiding this comment

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

@datapythonista I agree with you in general :-), but here I think the 'col1' etc actually makes it easier to see all the different possible output formats (to clearly see where the column names go in the specific output type).
But 'a', 'b' is indeed less clear, but so I would rather call them 'row1', 'row2.

Copy link
Member

Choose a reason for hiding this comment

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

That also makes sense. I'm personally more comfortable with something like {'cat': {'legs': 4, 'tail': 1}} than {'row1': {'col1': 0.75, 'col2': 1}}, but as far as it's not needed to spend a lot of unnecessary time until the example is understood, I'm happy with any option.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry to bother you again with the same @Moisan, but do you mind replacing the labels of the rows by row1 and row2, instead of a and b? I think that will make the example clearer


You can also specify the mapping type.

Expand Down