Skip to content

Commit 1aa5bfe

Browse files
committed
Add :ref: targets to recwarn.rst.
1 parent a6084ed commit 1aa5bfe

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Kevin Cox
8383
Lee Kamentsky
8484
Lev Maximov
8585
Lukas Bednar
86+
Luke Murphy
8687
Maciek Fijalkowski
8788
Maho
8889
Marc Schlaich

CHANGELOG.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
* Add hint to error message hinting possible missing __init__.py (`#478`_). Thanks `@DuncanBetts`_.
55

6+
* Provide ``:ref:`` targets for ``recwarn.rst`` so we can use intersphinx referencing.
7+
Thanks to `@dupuy`_ for the report and `@lwm`_ for the PR.
8+
69
* An error message is now displayed if ``--confcutdir`` is not a valid directory, avoiding
710
subtle bugs (`#2078`_).
811
Thanks `@nicoddemus`_ for the PR.
@@ -19,6 +22,8 @@
1922

2023
*
2124

25+
.. _@dupuy: https://bitbucket.org/dupuy/
26+
.. _@lwm: https://github.com/lwm
2227
.. _@adler-j: https://github.com/adler-j
2328
.. _@DuncanBetts: https://github.com/DuncanBetts
2429
.. _@nedbat: https://github.com/nedbat

doc/en/recwarn.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
.. _`asserting warnings`:
2+
13
.. _assertwarnings:
24

35
Asserting Warnings
46
=====================================================
57

8+
.. _`asserting warnings with the warns function`:
9+
610
.. _warns:
711

812
Asserting warnings with the warns function
@@ -46,6 +50,8 @@ Alternatively, you can examine raised warnings in detail using the
4650
``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated
4751
differently; see :ref:`ensuring_function_triggers`.
4852

53+
.. _`recording warnings`:
54+
4955
.. _recwarn:
5056

5157
Recording warnings
@@ -96,6 +102,8 @@ class of the warning. The ``message`` is the warning itself; calling
96102
``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated
97103
differently; see :ref:`ensuring_function_triggers`.
98104

105+
.. _`ensuring a function triggers a deprecation warning`:
106+
99107
.. _ensuring_function_triggers:
100108

101109
Ensuring a function triggers a deprecation warning

0 commit comments

Comments
 (0)