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.

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

DOC: consistent docstring for compression kwarg #22066

Merged
merged 1 commit into from
Jul 28, 2018

Conversation

minggli
Copy link
Contributor

@minggli minggli commented Jul 26, 2018

#17900 (comment) removed zip from docstring. But the support to write zip compression was added during March and April this year (mainly #20394 and a few patches) and now in functional and in production.

Because #17900 started when there is no zip writing and merged after zip writing support is added, it appears to have inadvertently changed docstring. This PR disambiguates and reflects production.

import os
import pandas as pd

a = pd.DataFrame(10000 * [[123, 234, 435]], columns=['A', 'B', 'C'])
a.to_csv('test_compressed', index=False, compression='zip')
b = pd.read_csv('test_compressed', compression='zip')

assert a.equals(b)
os.remove('test_compressed')

>>> pd.__version__
'0.23.3'

@minggli minggli changed the title consistent docstring compression kwarg DOC: consistent docstring for compression kwarg Jul 26, 2018
@TomAugspurger TomAugspurger added Docs IO Data IO issues that don't fit into a more specific label labels Jul 26, 2018
@codecov
Copy link

codecov bot commented Jul 26, 2018

Codecov Report

Merging #22066 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #22066   +/-   ##
=======================================
  Coverage   92.05%   92.05%           
=======================================
  Files         170      170           
  Lines       50708    50708           
=======================================
  Hits        46677    46677           
  Misses       4031     4031
Flag Coverage Δ
#multiple 90.45% <ø> (ø) ⬆️
#single 42.36% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/generic.py 96.47% <ø> (ø) ⬆️
pandas/core/frame.py 97.19% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be6ad72...54e1526. Read the comment docs.

@jreback jreback added this to the 0.24.0 milestone Jul 28, 2018
@jreback jreback merged commit 78adc53 into pandas-dev:master Jul 28, 2018
@jreback
Copy link
Contributor

jreback commented Jul 28, 2018

thanks @minggli

@minggli minggli deleted the docs/restore_zip_compression branch July 28, 2018 14:50
minggli added a commit to minggli/pandas that referenced this pull request Jul 28, 2018
* master:
  BENCH: asv csv reading benchmarks no longer read StringIO objects off the end (pandas-dev#21807)
  BUG: df.agg, df.transform and df.apply use different methods when axis=1 than when axis=0 (pandas-dev#21224)
  BUG: bug in GroupBy.count where arg minlength passed to np.bincount must be None for np<1.13 (pandas-dev#21957)
  CLN: Vbench to asv conversion script (pandas-dev#22089)
  consistent docstring (pandas-dev#22066)
  TST: skip pytables test with not-updated pytables conda package (pandas-dev#22099)
  CLN: Remove Legacy MultiIndex Index Compatibility (pandas-dev#21740)
  DOC: Reword doc for filepath_or_buffer in read_csv (pandas-dev#22058)
  BUG: rolling with MSVC 2017 build (pandas-dev#21813)
dhimmel added a commit to dhimmel/pandas that referenced this pull request Jul 29, 2018
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Data IO issues that don't fit into a more specific label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants