Skip to content

Commit 3116972

Browse files
committed
Add versionchanged
1 parent d71f4f2 commit 3116972

File tree

9 files changed

+47
-2
lines changed

9 files changed

+47
-2
lines changed

pandas/core/frame.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2568,10 +2568,13 @@ def to_stata(
25682568
format. Only available if version is 117. Storing strings in the
25692569
StrL format can produce smaller dta files if strings have more than
25702570
8 characters and values are repeated.
2571+
25712572
{compression_options}
25722573
25732574
.. versionadded:: 1.1.0
25742575
2576+
.. versionchanged: 1.4.0 Zstandard support.
2577+
25752578
{storage_options}
25762579
25772580
.. versionadded:: 1.2.0
@@ -3018,7 +3021,11 @@ def to_xml(
30183021
layout of elements and attributes from original output. This
30193022
argument requires ``lxml`` to be installed. Only XSLT 1.0
30203023
scripts and not later versions is currently supported.
3024+
30213025
{compression_options}
3026+
3027+
.. versionchanged: 1.4.0 Zstandard support.
3028+
30223029
{storage_options}
30233030
30243031
Returns

pandas/core/generic.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2410,6 +2410,9 @@ def to_json(
24102410
list-like.
24112411
24122412
{compression_options}
2413+
2414+
.. versionchanged:: 1.4.0 Zstandard support.
2415+
24132416
index : bool, default True
24142417
Whether to include the index values in the JSON string. Not
24152418
including the index (``index=False``) is only supported when

pandas/io/common.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,11 @@ def _get_filepath_or_buffer(
267267
----------
268268
filepath_or_buffer : a url, filepath (str, py.path.local or pathlib.Path),
269269
or buffer
270+
270271
{compression_options}
272+
273+
.. versionchanged:: 1.4.0 Zstandard support.
274+
271275
encoding : the encoding to use to decode bytes, default is 'utf-8'
272276
mode : str, optional
273277
@@ -511,8 +515,11 @@ def infer_compression(
511515
----------
512516
filepath_or_buffer : str or file handle
513517
File path or object.
518+
514519
{compression_options}
515520
521+
.. versionchanged:: 1.4.0 Zstandard support.
522+
516523
Returns
517524
-------
518525
string or None
@@ -622,19 +629,20 @@ def get_handle(
622629
Mode to open path_or_buf with.
623630
encoding : str or None
624631
Encoding to use.
632+
625633
{compression_options}
626634
627635
.. versionchanged:: 1.0.0
628-
629636
May now be a dict with key 'method' as compression mode
630637
and other keys as compression options if compression
631638
mode is 'zip'.
632639
633640
.. versionchanged:: 1.1.0
634-
635641
Passing compression options as keys in dict is now
636642
supported for compression modes 'gzip', 'bz2', 'zstd' and 'zip'.
637643
644+
.. versionchanged:: 1.4.0 Zstandard support.
645+
638646
memory_map : bool, default False
639647
See parsers._parser_params for more information.
640648
is_text : bool, default True

pandas/io/formats/xml.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ class BaseXMLFormatter:
7979
8080
{compression_options}
8181
82+
.. versionchanged: 1.4.0 Zstandard support.
83+
8284
storage_options : dict, optional
8385
Extra options that make sense for a particular storage connection,
8486
e.g. host, port, username, password, etc.,

pandas/io/json/_json.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,8 @@ def read_json(
480480
481481
{decompression_options}
482482
483+
.. versionchanged: 1.4.0 Zstandard support.
484+
483485
nrows : int, optional
484486
The number of lines from the line-delimited jsonfile that has to be read.
485487
This can only be passed if `lines=True`.

pandas/io/parsers/readers.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,11 @@
280280
.. versionchanged:: 1.2
281281
282282
``TextFileReader`` is a context manager.
283+
283284
{decompression_options}
285+
286+
.. versionchanged: 1.4.0 Zstandard support.
287+
284288
thousands : str, optional
285289
Thousands separator.
286290
decimal : str, default '.'

pandas/io/pickle.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ def to_pickle(
4747
Accept URL. URL has to be of S3 or GCS.
4848
4949
{compression_options}
50+
51+
.. versionchanged:: 1.4.0 Zstandard support.
52+
5053
protocol : int
5154
Int which indicates which protocol should be used by the pickler,
5255
default HIGHEST_PROTOCOL (see [1], paragraph 12.1.2). The possible
@@ -139,6 +142,9 @@ def read_pickle(
139142
Accept URL. URL is not limited to S3 and GCS.
140143
141144
{decompression_options}
145+
146+
.. versionchanged:: 1.4.0 Zstandard support.
147+
142148
{storage_options}
143149
144150
.. versionadded:: 1.2.0

pandas/io/stata.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2194,10 +2194,13 @@ class StataWriter(StataParser):
21942194
variable_labels : dict
21952195
Dictionary containing columns as keys and variable labels as values.
21962196
Each label must be 80 characters or smaller.
2197+
21972198
{compression_options}
21982199
21992200
.. versionadded:: 1.1.0
22002201
2202+
.. versionchanged:: 1.4.0 Zstandard support.
2203+
22012204
{storage_options}
22022205
22032206
.. versionadded:: 1.2.0
@@ -3119,10 +3122,13 @@ class StataWriter117(StataWriter):
31193122
Smaller columns can be converted by including the column name. Using
31203123
StrLs can reduce output file size when strings are longer than 8
31213124
characters, and either frequently repeated or sparse.
3125+
31223126
{compression_options}
31233127
31243128
.. versionadded:: 1.1.0
31253129
3130+
.. versionchanged:: 1.4.0 Zstandard support.
3131+
31263132
value_labels : dict of dicts
31273133
Dictionary containing columns as keys and dictionaries of column value
31283134
to labels as values. The combined length of all labels for a single
@@ -3511,10 +3517,13 @@ class StataWriterUTF8(StataWriter117):
35113517
The dta version to use. By default, uses the size of data to determine
35123518
the version. 118 is used if data.shape[1] <= 32767, and 119 is used
35133519
for storing larger DataFrames.
3520+
35143521
{compression_options}
35153522
35163523
.. versionadded:: 1.1.0
35173524
3525+
.. versionchanged:: 1.4.0 Zstandard support.
3526+
35183527
value_labels : dict of dicts
35193528
Dictionary containing columns as keys and dictionaries of column value
35203529
to labels as values. The combined length of all labels for a single

pandas/io/xml.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ class _XMLFrameParser:
7575
7676
{decompression_options}
7777
78+
.. versionchanged: 1.4.0 Zstandard support.
79+
7880
storage_options : dict, optional
7981
Extra options that make sense for a particular storage connection,
8082
e.g. host, port, username, password, etc.,
@@ -810,6 +812,8 @@ def read_xml(
810812
811813
{decompression_options}
812814
815+
.. versionchanged: 1.4.0 Zstandard support.
816+
813817
{storage_options}
814818
815819
Returns

0 commit comments

Comments
 (0)