Skip to content

Commit e673061

Browse files
authored
update doc comments
1 parent 9a85cba commit e673061

File tree

6 files changed

+22
-22
lines changed

6 files changed

+22
-22
lines changed

pandas/core/frame.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3020,11 +3020,11 @@ def to_xml(
30203020
layout of elements and attributes from original output. This
30213021
argument requires ``lxml`` to be installed. Only XSLT 1.0
30223022
scripts and not later versions is currently supported.
3023-
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', None}}, default 'infer'
3023+
compression : {{'infer', 'gzip', 'bz2', 'zip', 'tar', 'xz', None}}, default 'infer'
30243024
For on-the-fly decompression of on-disk data. If 'infer', then use
3025-
gzip, bz2, zip or xz if path_or_buffer is a string ending in
3026-
'.gz', '.bz2', '.zip', or 'xz', respectively, and no decompression
3027-
otherwise. If using 'zip', the ZIP file must contain only one data
3025+
gzip, bz2, zip, xz or tar if path_or_buffer is a string ending in
3026+
'.gz', '.bz2', '.zip', '.xz' or containing '.tar' respectively, and no decompression
3027+
otherwise. If using 'zip' or 'tar', the archive must contain only one data
30283028
file to be read in. Set to None for no decompression.
30293029
{storage_options}
30303030

pandas/io/common.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ def _get_filepath_or_buffer(
263263
----------
264264
filepath_or_buffer : a url, filepath (str, py.path.local or pathlib.Path),
265265
or buffer
266-
compression : {{'gzip', 'bz2', 'zip', 'xz', None}}, optional
266+
compression : {{'gzip', 'bz2', 'zip', 'xz', 'tar', None}}, optional
267267
encoding : the encoding to use to decode bytes, default is 'utf-8'
268268
mode : str, optional
269269
@@ -497,9 +497,9 @@ def infer_compression(
497497
----------
498498
filepath_or_buffer : str or file handle
499499
File path or object.
500-
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}
500+
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', 'tar', None}
501501
If 'infer' and `filepath_or_buffer` is path-like, then detect
502-
compression from the following extensions: '.gz', '.bz2', '.zip',
502+
compression from the following extensions: '.gz', '.bz2', '.zip', '.tar',
503503
or '.xz' (otherwise no compression).
504504
505505
Returns

pandas/io/json/_json.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -475,11 +475,11 @@ def read_json(
475475
476476
``JsonReader`` is a context manager.
477477
478-
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', None}}, default 'infer'
478+
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', 'tar', None}}, default 'infer'
479479
For on-the-fly decompression of on-disk data. If 'infer', then use
480-
gzip, bz2, zip or xz if path_or_buf is a string ending in
481-
'.gz', '.bz2', '.zip', or 'xz', respectively, and no decompression
482-
otherwise. If using 'zip', the ZIP file must contain only one data
480+
gzip, bz2, zip, xz or tar if path_or_buf is a string ending in
481+
'.gz', '.bz2', '.zip', '.xz' or containing '.tar' respectively, and no decompression
482+
otherwise. If using 'zip' or 'tar', the archive must contain only one data
483483
file to be read in. Set to None for no decompression.
484484
485485
nrows : int, optional

pandas/io/parsers/readers.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,11 @@
279279
.. versionchanged:: 1.2
280280
281281
``TextFileReader`` is a context manager.
282-
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', None}}, default 'infer'
282+
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', 'tar', None}}, default 'infer'
283283
For on-the-fly decompression of on-disk data. If 'infer' and
284284
`filepath_or_buffer` is path-like, then detect compression from the
285-
following extensions: '.gz', '.bz2', '.zip', or '.xz' (otherwise no
286-
decompression). If using 'zip', the ZIP file must contain only one data
285+
following extensions: '.gz', '.bz2', '.zip', '.tar', '.xz' (otherwise no
286+
decompression). If using 'zip' or 'tar', the archive must contain only one data
287287
file to be read in. Set to None for no decompression.
288288
thousands : str, optional
289289
Thousands separator.

pandas/io/pickle.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ def read_pickle(
134134
.. versionchanged:: 1.0.0
135135
Accept URL. URL is not limited to S3 and GCS.
136136
137-
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', None}}, default 'infer'
137+
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', 'tar', None}}, default 'infer'
138138
If 'infer' and 'path_or_url' is path-like, then detect compression from
139-
the following extensions: '.gz', '.bz2', '.zip', or '.xz' (otherwise no
139+
the following extensions: '.gz', '.bz2', '.zip', '.tar', or '.xz' (otherwise no
140140
compression) If 'infer' and 'path_or_url' is not path-like, then use
141141
None (= no decompression).
142142

pandas/io/xml.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ class _XMLFrameParser:
6868
URL, file, file-like object, or a raw string containing XSLT,
6969
`etree` does not support XSLT but retained for consistency.
7070
71-
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, default 'infer'
71+
compression : {'infer', 'gzip', 'bz2', 'zip', 'tar', 'xz', None}, default 'infer'
7272
Compression type for on-the-fly decompression of on-disk data.
73-
If 'infer', then use extension for gzip, bz2, zip or xz.
73+
If 'infer', then use extension for gzip, bz2, zip, tar or xz.
7474
7575
storage_options : dict, optional
7676
Extra options that make sense for a particular storage connection,
@@ -801,11 +801,11 @@ def read_xml(
801801
transformation and not the original XML document. Only XSLT 1.0
802802
scripts and not later versions is currently supported.
803803
804-
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', None}}, default 'infer'
804+
compression : {{'infer', 'gzip', 'bz2', 'zip', 'xz', 'tar', None}}, default 'infer'
805805
For on-the-fly decompression of on-disk data. If 'infer', then use
806-
gzip, bz2, zip or xz if path_or_buffer is a string ending in
807-
'.gz', '.bz2', '.zip', or 'xz', respectively, and no decompression
808-
otherwise. If using 'zip', the ZIP file must contain only one data
806+
gzip, bz2, zip, xz, or tar if path_or_buffer is a string ending in
807+
'.gz', '.bz2', '.zip', '.xz', or containing '.tar' respectively, and no decompression
808+
otherwise. If using 'zip' or 'tar', the archive must contain only one data
809809
file to be read in. Set to None for no decompression.
810810
811811
{storage_options}

0 commit comments

Comments
 (0)