Skip to content

Commit 687f01d

Browse files
committed
DOC: whatsnew updates
1 parent e8ef4f8 commit 687f01d

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

doc/source/io.rst

+1
Original file line numberDiff line numberDiff line change
@@ -4093,6 +4093,7 @@ The key functions are:
40934093

40944094
.. _io.bigquery_reader:
40954095

4096+
.. _io.bigquery_authentication:
40964097

40974098
Authentication
40984099
''''''''''''''

doc/source/release.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ users upgrade to this version.
4848

4949
Highlights include:
5050

51-
Highlights include:
52-
5351
- Window functions are now methods on ``.groupby`` like objects, see :ref:`here <whatsnew_0180.enhancements.moments>`.
54-
- API breaking ``.resample`` changes to make it more ``.groupby`` like, see :ref:`here <whatsnew_0180.resample>`.
52+
- ``pd.test()`` top-level nose test runner is available (:issue:`4327`)
53+
- Adding support for a ``RangeIndex`` as a specialized form of the ``Int64Index`` for memory savings, see :ref:`here <whatsnew_0180.enhancements.rangeindex>`.
54+
- API breaking ``.resample`` changes to make it more ``.groupby`` like, see :ref:`here <whatsnew_0180.breaking.resample>`.
5555

5656
See the :ref:`v0.18.0 Whatsnew <whatsnew_0180>` overview for an extensive list
5757
of all enhancements and bugs that have been fixed in 0.17.1.

doc/source/whatsnew/v0.18.0.txt

+10-13
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Highlights include:
2020
- Window functions are now methods on ``.groupby`` like objects, see :ref:`here <whatsnew_0180.enhancements.moments>`.
2121
- ``pd.test()`` top-level nose test runner is available (:issue:`4327`)
2222
- Adding support for a ``RangeIndex`` as a specialized form of the ``Int64Index`` for memory savings, see :ref:`here <whatsnew_0180.enhancements.rangeindex>`.
23-
- API breaking ``.resample`` changes to make it more ``.groupby`` like, see :ref:`here <whatsnew_0180.resample>`.
23+
- API breaking ``.resample`` changes to make it more ``.groupby`` like, see :ref:`here <whatsnew_0180.breaking.resample>`.
2424

2525
Check the :ref:`API Changes <whatsnew_0180.api_breaking>` and :ref:`deprecations <whatsnew_0180.deprecations>` before updating.
2626

@@ -401,8 +401,7 @@ other anchored offsets like ``MonthBegin`` and ``YearBegin``.
401401
Resample API
402402
^^^^^^^^^^^^
403403

404-
Like the change in the window functions API :ref:`above <whatsnew_0180.enhancements.moments>`, ``.resample(...)`` is changing to have
405-
a more groupby-like API. (:issue:`11732`, :issue:`12702`).
404+
Like the change in the window functions API :ref:`above <whatsnew_0180.enhancements.moments>`, ``.resample(...)`` is changing to have a more groupby-like API. (:issue:`11732`, :issue:`12702`).
406405

407406
.. ipython:: python
408407

@@ -415,9 +414,8 @@ a more groupby-like API. (:issue:`11732`, :issue:`12702`).
415414

416415
**Previous API**:
417416

418-
You would write a resampling operation that immediately evaluates.
419-
420-
This defaults to ``how='mean'``
417+
You would write a resampling operation that immediately evaluates. If a ``how`` parameter was not provided, it
418+
would default to ``how='mean'``.
421419

422420
.. code-block:: python
423421

@@ -445,7 +443,7 @@ You could also specify a ``how`` directly
445443

446444
.. warning::
447445

448-
This new API for resample includes some internal changes that previous API (pre 0.18.0), to work with a deprecation warning in most cases. Since the returned resample is now a deferred object, and not immediately evaluated (as before). We can intercept operations and just do what the (pre 0.18.0) API did (with a warning). Here is a typical use case:
446+
This new API for resample includes some internal changes for the prior-to-0.18.0 API, to work with a deprecation warning in most cases, as the resample operation returns a deferred object. We can intercept operations and just do what the (pre 0.18.0) API did (with a warning). Here is a typical use case:
449447

450448
.. code-block:: python
451449

@@ -474,7 +472,7 @@ You could also specify a ``how`` directly
474472

475473
**New API**:
476474

477-
Now, you write ``.resample`` as a 2-stage operation like groupby, which
475+
Now, you can write ``.resample`` as a 2-stage operation like groupby, which
478476
yields a ``Resampler``.
479477

480478
.. ipython:: python
@@ -485,7 +483,7 @@ yields a ``Resampler``.
485483
Downsampling
486484
''''''''''''
487485

488-
You can then use this object to perform similar operations.
486+
You can then use this object to perform operations.
489487
These are downsampling operations (going from a lower frequency to a higher one).
490488

491489
.. ipython:: python
@@ -635,16 +633,15 @@ Other API Changes
635633
In [2]: s.between_time('20150101 07:00:00','20150101 09:00:00')
636634
ValueError: Cannot convert arg ['20150101 07:00:00'] to a time.
637635

638-
- ``.memory_usage`` now includes values in the index, as does memory_usage in ``.info`` (:issue:`11597`)
636+
- ``.memory_usage()`` now includes values in the index, as does memory_usage in ``.info`` (:issue:`11597`)
639637

640638
- ``DataFrame.to_latex()`` now supports non-ascii encodings (eg utf-8) in Python 2 with the parameter ``encoding`` (:issue:`7061`)
641639

642640
- ``pandas.merge()`` and ``DataFrame.merge()`` will show a specific error message when trying to merge with an object that is not of type ``DataFrame`` or a subclass (:issue:`12081`)
643641

644642
- ``DataFrame.unstack`` and ``Series.unstack`` now take ``fill_value`` keyword to allow direct replacement of missing values when an unstack results in missing values in the resulting ``DataFrame``. As an added benefit, specifying ``fill_value`` will preserve the data type of the original stacked data. (:issue:`9746`)
645643

646-
- As part of the new API for :ref:`window functions <whatsnew_0180.enhancements.moments>` and :ref:`resampling <whatsnew_0180.resample>`, aggregation functions have been
647-
clarified, raising more informative error messages on invalid aggregations. (:issue:`9052`). A full set of examples are presented in :ref:`groupby <groupby.aggregation>`.
644+
- As part of the new API for :ref:`window functions <whatsnew_0180.enhancements.moments>` and :ref:`resampling <whatsnew_0180.breaking.resample>`, aggregation functions have been clarified, raising more informative error messages on invalid aggregations. (:issue:`9052`). A full set of examples are presented in :ref:`groupby <groupby.aggregation>`.
648645

649646
.. _whatsnew_0180.deprecations:
650647

@@ -687,7 +684,7 @@ Deprecations
687684
- ``pd.tseries.frequencies.get_offset_name`` function is deprecated. Use offset's ``.freqstr`` property as alternative (:issue:`11192`)
688685
- ``pandas.stats.fama_macbeth`` routines are deprecated and will be removed in a future version (:issue:`6077`)
689686
- ``pandas.stats.ols``, ``pandas.stats.plm`` and ``pandas.stats.var`` routines are deprecated and will be removed in a future version (:issue:`6077`)
690-
- show a ``FutureWarning`` rather than a ``DeprecationWarning`` on using long-time deprecated syntax in ``HDFStore.select``, where ``where`` clause is not a string-like (:issue:`12027`)
687+
- show a ``FutureWarning`` rather than a ``DeprecationWarning`` on using long-time deprecated syntax in ``HDFStore.select``, where the ``where`` clause is not a string-like (:issue:`12027`)
691688

692689
.. _whatsnew_0180.prior_deprecations:
693690

0 commit comments

Comments
 (0)