Skip to content

Fix incorrect example in wide_to_long docstring #25736

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

Closed
wants to merge 8 commits into from
Closed

Fix incorrect example in wide_to_long docstring #25736

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d472c17
Fix incorrect example in wide_to_long docstring
Mar 14, 2019
5bda59c
Merge branch 'master' into update-docs
bharatr21 Mar 14, 2019
26a28d5
More changes to docstring, added CI, removed whatsnew courtesy @TomAu…
Mar 15, 2019
cda32f0
Fixed ellipsis, added back whatsnew
Mar 15, 2019
aebff33
Final doctest fix
Mar 15, 2019
87a0867
Final doctest fix
Mar 15, 2019
e7b1679
Final doctest fix
Mar 15, 2019
b182905
Merge remote-tracking branch 'upstream/master' into update-docs
Mar 20, 2019
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 doc/source/whatsnew/v0.25.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Reshaping
- Bug in :func:`merge` when merging by index name would sometimes result in an incorrectly numbered index (:issue:`24212`)
- :func:`to_records` now accepts dtypes to its `column_dtypes` parameter (:issue:`24895`)
- Bug in :func:`concat` where order of ``OrderedDict`` (and ``dict`` in Python 3.6+) is not respected, when passed in as ``objs`` argument (:issue:`21510`)

- Bug in last example in docstring of :func:`wide_to_long` has been fixed (:issue:`25733`)

Sparse
^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/reshape/melt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ def wide_to_long(df, stubnames, i, j, sep="", suffix=r'\d+'):
8 3 3 2.1 2.9

>>> l = pd.wide_to_long(df, stubnames='ht', i=['famid', 'birth'], j='age',
sep='_', suffix='\w')
sep='_', suffix='\w+')
Copy link
Contributor

Choose a reason for hiding this comment

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

Need ... under the >>>.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Errors:

################################### Doctests ###################################
################################################################################

**********************************************************************
Line 94, in pandas.wide_to_long
Failed example:
    df
Expected:
       birth  famid  ht1  ht2
    0      1      1  2.8  3.4
    1      2      1  2.9  3.8
    2      3      1  2.2  2.9
    3      1      2  2.0  3.2
    4      2      2  1.8  2.8
    5      3      2  1.9  2.4
    6      1      3  2.2  3.3
    7      2      3  2.3  3.4
    8      3      3  2.1  2.9
Got:
       famid  birth  ht1  ht2
    0      1      1  2.8  3.4
    1      1      2  2.9  3.8
    2      1      3  2.2  2.9
    3      2      1  2.0  3.2
    4      2      2  1.8  2.8
    5      2      3  1.9  2.4
    6      3      1  2.2  3.3
    7      3      2  2.3  3.4
    8      3      3  2.1  2.9
**********************************************************************
Line 154, in pandas.wide_to_long
Failed example:
    df # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
Expected:
       A(quarterly)-2010  A(quarterly)-2011  B(quarterly)-2010  ...
    0           0.548814           0.544883           0.437587  ...
    1           0.715189           0.423655           0.891773  ...
    2           0.602763           0.645894           0.963663  ...
       X  id
    0  0   0
    1  1   1
    2  1   2
Got:
       A(quarterly)-2010  A(quarterly)-2011  B(quarterly)-2010  B(quarterly)-2011  X  id
    0           0.548814           0.544883           0.437587           0.383442  0   0
    1           0.715189           0.423655           0.891773           0.791725  1   1
    2           0.602763           0.645894           0.963663           0.528895  1   2
**********************************************************************
Line 195, in pandas.wide_to_long
Failed example:
    df
Expected:
       birth  famid  ht_one  ht_two
    0      1      1     2.8     3.4
    1      2      1     2.9     3.8
    2      3      1     2.2     2.9
    3      1      2     2.0     3.2
    4      2      2     1.8     2.8
    5      3      2     1.9     2.4
    6      1      3     2.2     3.3
    7      2      3     2.3     3.4
    8      3      3     2.1     2.9
Got:
       famid  birth  ht_one  ht_two
    0      1      1     2.8     3.4
    1      1      2     2.9     3.8
    2      1      3     2.2     2.9
    3      2      1     2.0     3.2
    4      2      2     1.8     2.8
    5      2      3     1.9     2.4
    6      3      1     2.2     3.3
    7      3      2     2.3     3.4
    8      3      3     2.1     2.9

and after my attempted fix,

################################################################################
################################### Doctests ###################################
################################################################################

**********************************************************************
Line 154, in pandas.wide_to_long
Failed example:
    df # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS
Expected:
       A(quarterly)-2010  A(quarterly)-2011  B(quarterly)-2010  ...
    0           0.548814           0.544883           0.437587  ...
    1           0.715189           0.423655           0.891773  ...
    2           0.602763           0.645894           0.963663  ...
       X  id
    0  0   0
    1  1   1
    2  1   2
Got:
       A(quarterly)-2010  A(quarterly)-2011  B(quarterly)-2010  B(quarterly)-2011  X  id
    0           0.548814           0.544883           0.437587           0.383442  0   0
    1           0.715189           0.423655           0.891773           0.791725  1   1
    2           0.602763           0.645894           0.963663           0.528895  1   2

The ELLIPSIS is not being considered or ignored by doctest as it ought to be. Perhaps another PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The doctest, and hence the entire pipeline is failing only due to this ELLIPSIS error @TomAugspurger any suggestions on what to do? (If I put all columns, pylint and flake8 fails because it exceeds 79 chars)

Copy link
Contributor

Choose a reason for hiding this comment

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

Answered in
https://github.com/pandas-dev/pandas/pull/25736/files#r265931954

>>> l
... # doctest: +NORMALIZE_WHITESPACE
ht
Expand Down