Review changelog entries for features branch
I used `towncrier --draft` to see the full changelog, and decided to "nitpick" it so it reads better as a whole.
This commit is contained in:
		
							parent
							
								
									437f44a1f4
								
							
						
					
					
						commit
						98987177a0
					
				| 
						 | 
					@ -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.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
					See our `docs <https://docs.pytest.org/en/latest/deprecations.html#yield-tests>`__ on information on how to update your code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
					See our `docs <https://docs.pytest.org/en/latest/deprecations.html#metafunc-addcall>`__ on information on how to update your code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,16 +1,22 @@
 | 
				
			||||||
A warning is now issued when assertions are made for ``None``.
 | 
					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.
 | 
					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
 | 
					    assert variable is None
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
					See our `docs <https://docs.pytest.org/en/latest/deprecations.html#internal-classes-accessed-through-node>`__ on information on how to update your code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
				
			||||||
| 
						 | 
					@ -1 +0,0 @@
 | 
				
			||||||
A CACHEDIR.TAG file gets added to the cache directory.
 | 
					 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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``.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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
 | 
					It handles ``header`` similar to Python 3.7 does it, and forwards any
 | 
				
			||||||
other keyword arguments to the ``Pdb`` constructor.
 | 
					other keyword arguments to the ``Pdb`` constructor.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
					See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-namespace>`__ on information on how to update your code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1 +1 @@
 | 
				
			||||||
Fix ``raises(..., 'code(string)')`` frame filename.
 | 
					Fixed ``raises(..., 'code(string)')`` frame filename.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,2 +1,9 @@
 | 
				
			||||||
Add ini parameter ``junit_time`` to optionally report test call
 | 
					Added ini parameter ``junit_time`` to optionally report test call durations, excluding setup and teardown times.
 | 
				
			||||||
durations less 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
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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.
 | 
					See our `docs <https://docs.pytest.org/en/latest/deprecations.html#pytest-funcarg-prefix>`__ on information on how to update your code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue