DOC: fixes for assert_frame_equal check_freq argument (pandas-dev#38471)

* add versionadded to asset_frame_equals check_freq

* Add whats new for assert_frame_equal check_freq arg.

* fix backticks

* move whatnew to 1.2.1

* whitespace

* rename to API breaking section

Co-authored-by: Keppler, Kyle <[email protected]>

Author: 2 people

doc/source/whatsnew/v1.2.1.rst

@@ -10,6 +10,20 @@ including other versions of pandas.
 
 .. ---------------------------------------------------------------------------
 
+.. _whatsnew_121.api_breaking:
+
+Backwards incompatible API changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _whatsnew_121.api_breaking.testing.assert_frame_equal:
+
+Added ``check_freq`` argument to ``testing.assert_frame_equal``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``check_freq`` argument was added to :func:`testing.assert_frame_equal` in pandas 1.1.0 and defaults to ``True``. :func:`testing.assert_frame_equal` now raises ``AssertionError`` if the indexes do not have the same frequency. Before pandas 1.1.0, the index frequency was not checked by :func:`testing.assert_frame_equal`.
+
+.. ---------------------------------------------------------------------------
+
 .. _whatsnew_121.regressions:
 
 Fixed regressions

pandas/_testing/asserters.py

@@ -1128,6 +1128,8 @@ def assert_frame_equal(
         (same as in columns) - same labels must be with the same data.
     check_freq : bool, default True
         Whether to check the `freq` attribute on a DatetimeIndex or TimedeltaIndex.
+
+        .. versionadded:: 1.1.0
     check_flags : bool, default True
         Whether to check the `flags` attribute.
     rtol : float, default 1e-5