Skip to content

DOC: to_pickle function takes pickle v5 but doc says only 1-4 supported #37316

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
Closed
ianozsvald opened this issue Oct 21, 2020 · 3 comments · Fixed by #37322
Closed

DOC: to_pickle function takes pickle v5 but doc says only 1-4 supported #37316

ianozsvald opened this issue Oct 21, 2020 · 3 comments · Fixed by #37322
Assignees
@botplex
Labels
Docs good first issue
Milestone
1.2

Comments

@ianozsvald
Copy link
Contributor

Location of the documentation

Documentation problem

The docstring states DataFrame.to_pickle(path, compression='infer', protocol=5, storage_options=None) noting protocol 5 by default, the Parameters following text notes "The possible values are 0, 1, 2, 3, 4" which does not include protocol 5.

Suggested fix for documentation

Add "5" to the docs: "The possible values are 0, 1, 2, 3, 4, 5" which was included from Python 3.8 https://docs.python.org/3/library/pickle.html
@ianozsvald ianozsvald added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 21, 2020
@jorisvandenbossche jorisvandenbossche added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 21, 2020
@jorisvandenbossche jorisvandenbossche added this to the 2.0 milestone Oct 21, 2020
@jorisvandenbossche
Copy link
Member

Thanks for the catch, indeed a good easy issue!

@jorisvandenbossche jorisvandenbossche changed the title DOC: to_pickle function takes pickle v5 but doc says only 1-4 supported (easy doc fix, first timer suggested) DOC: to_pickle function takes pickle v5 but doc says only 1-4 supported Oct 21, 2020
@botplex
Copy link
Contributor

botplex commented Oct 21, 2020

I will take this one

@botplex
Copy link
Contributor

botplex commented Oct 21, 2020

take

botplex added a commit to botplex/pandas that referenced this issue Oct 21, 2020
@botplex
DOC: Add protocol value '5' to pickle pandas-dev#37316
be56962
@botplex botplex mentioned this issue Oct 21, 2020
Merged
1 task
@jreback jreback modified the milestones: 2.0, 1.2 Oct 22, 2020
jreback pushed a commit that referenced this issue Oct 22, 2020
@botplex
DOC: Add protocol value '5' to pickle #37316 (#37322)
ef5ccfd
botplex added a commit to botplex/pandas that referenced this issue Oct 22, 2020
@botplex
DOC: Add protocol value '5' to pickle pandas-dev#37316
7e4ceff
@botplex botplex mentioned this issue Oct 22, 2020
Closed
1 task
JulianWgs pushed a commit to JulianWgs/pandas that referenced this issue Oct 26, 2020
@botplex @JulianWgs
DOC: Add protocol value '5' to pickle pandas-dev#37316 (pandas-dev#37322
36544e8 
)
kesmit13 pushed a commit to kesmit13/pandas that referenced this issue Nov 2, 2020
@botplex
DOC: Add protocol value '5' to pickle pandas-dev#37316 (pandas-dev#37322
689fb33 
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@botplex botplex

Labels
Docs good first issue
Projects
None yet
Milestone
1.2
Development

Successfully merging a pull request may close this issue.

DOC: Add protocol value '5' to pickle #37316 botplex/pandas
1.1.x botplex/pandas
4 participants
@ianozsvald @jreback @jorisvandenbossche @botplex