Merge pull request #4552 from nicoddemus/review-changelog-entries

Review changelog entries for features branch

changelog/3050.deprecation.rst

@@ -1 +1,3 @@
-Deprecate ``pytest.config`` global.  See https://docs.pytest.org/en/latest/deprecations.html#pytest-config-global
+Deprecated the ``pytest.config`` global.
+
+See https://docs.pytest.org/en/latest/deprecations.html#pytest-config-global for rationale.

changelog/3079.removal.rst

@@ -1,3 +1,3 @@
-Remove support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated.
+Removed support for yield tests - they are fundamentally broken because they don't support fixtures properly since collection and test execution were separated.
 
 See our `docs <https://docs.pytest.org/en/latest/deprecations.html#yield-tests>`__ on information on how to update your code.

changelog/3083.removal.rst

@@ -1,3 +1,3 @@
-Remove ``Metafunc.addcall``. This was the predecessor mechanism to ``@pytest.mark.parametrize``.
+Removed ``Metafunc.addcall``. This was the predecessor mechanism to ``@pytest.mark.parametrize``.
 
 See our `docs <https://docs.pytest.org/en/latest/deprecations.html#metafunc-addcall>`__ on information on how to update your code.

changelog/3191.feature.rst

@@ -1,16 +1,22 @@
 A warning is now issued when assertions are made for ``None``.
 
-This is a common source of confusion among new users, which write::
+This is a common source of confusion among new users, which write:
 
-    assert mocked_object.assert_called_with(3, 4, 5, key='value')
+.. code-block:: python
 
-When they should write::
+    assert mocked_object.assert_called_with(3, 4, 5, key="value")
 
-    mocked_object.assert_called_with(3, 4, 5, key='value')
+When they should write:
+
+.. code-block:: python
+
+    mocked_object.assert_called_with(3, 4, 5, key="value")
 
 Because the ``assert_called_with`` method of mock objects already executes an assertion.
 
-This warning will not be issued when ``None`` is explicitly checked. An assertion like::
+This warning will not be issued when ``None`` is explicitly checked. An assertion like:
+
+.. code-block:: python
 
     assert variable is None
 

changelog/3616.removal.rst

@@ -1,3 +1,3 @@
-Remove the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now.
+Removed the deprecated compat properties for ``node.Class/Function/Module`` - use ``pytest.Class/Function/Module`` now.
 
 See our `docs <https://docs.pytest.org/en/latest/deprecations.html#internal-classes-accessed-through-node>`__ on information on how to update your code.

changelog/4278.feature.rst

@@ -0,0 +1,4 @@
+``CACHEDIR.TAG`` files are now created inside cache directories.
+
+Those files are part of the `Cache Directory Tagging Standard <http://www.bford.info/cachedir/spec.html>`__, and can
+be used by backup or synchronization programs to identify pytest's cache directory as such.

changelog/4278.trivial.rst

@@ -1 +0,0 @@
-A CACHEDIR.TAG file gets added to the cache directory.

changelog/4292.feature.rst

@@ -1 +1 @@
-``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``.
+``pytest.outcomes.Exit`` is derived from ``SystemExit`` instead of ``KeyboardInterrupt``. This allows us to better handle ``pdb`` exiting.

changelog/4386.feature.rst

@@ -1 +1 @@
-Restructure ExceptionInfo object construction and ensure incomplete instances have a ``repr``/``str``.
+Restructured ``ExceptionInfo`` object construction and ensure incomplete instances have a ``repr``/``str``.

changelog/4416.feature.rst

@@ -1,4 +1,4 @@
-pdb: support keyword arguments with ``pdb.set_trace``
+pdb: added support for keyword arguments with ``pdb.set_trace``.
 
 It handles ``header`` similar to Python 3.7 does it, and forwards any
 other keyword arguments to the ``Pdb`` constructor.

changelog/4421.removal.rst

@@ -1,3 +1,3 @@
-Remove the implementation of the ``pytest_namespace`` hook.
+Removed the implementation of the ``pytest_namespace`` hook.
 
 See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-namespace>`__ on information on how to update your code.

changelog/4435.bugfix.rst

@@ -1 +1 @@
-Fix ``raises(..., 'code(string)')`` frame filename.
+Fixed ``raises(..., 'code(string)')`` frame filename.

changelog/4435.deprecation.rst

@@ -1 +1,3 @@
-Deprecate ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``.  See https://docs.pytest.org/en/latest/deprecations.html#raises-warns-exec
+Deprecated ``raises(..., 'code(as_a_string)')`` and ``warns(..., 'code(as_a_string)')``.
+
+See https://docs.pytest.org/en/latest/deprecations.html#raises-warns-exec for rationale and examples.

changelog/4483.feature.rst

@@ -1,2 +1,9 @@
-Add ini parameter ``junit_time`` to optionally report test call
-durations less setup and teardown times.
+Added ini parameter ``junit_time`` to optionally report test call durations, excluding setup and teardown times.
+
+The JUnit XML specification and the default pytest behavior is to include setup and teardown times in the test duration
+report. You can include just the call durations instead (excluding setup and teardown) by adding this to your ``pytest.ini`` file:
+
+.. code-block:: ini
+
+    [pytest]
+    junit_time = call

changelog/4535.removal.rst

@@ -1 +1 @@
-Removed deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago.
+Removed the deprecated ``PyCollector.makeitem`` method. This method was made public by mistake a long time ago.

changelog/4543.removal.rst

@@ -1,3 +1,3 @@
-Remove support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``@pytest.fixture`` decorator instead.
+Removed support to define fixtures using the ``pytest_funcarg__`` prefix. Use the ``@pytest.fixture`` decorator instead.
 
 See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-funcarg-prefix>`__ on information on how to update your code.