p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add `:ref:` targets to `recwarn.rst`.

This commit is contained in:
Luke Murphy 2016-11-26 12:25:42 +01:00
parent a6084ed797
commit 1aa5bfea11
3 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AUTHORS
View File

@ -83,6 +83,7 @@ Kevin Cox
Lee Kamentsky Lee Kamentsky
Lev Maximov Lev Maximov
Lukas Bednar Lukas Bednar
Luke Murphy
Maciek Fijalkowski Maciek Fijalkowski
Maho Maho
Marc Schlaich Marc Schlaich

5
CHANGELOG.rst
View File

@ -3,6 +3,9 @@
* Add hint to error message hinting possible missing __init__.py (`#478`_). Thanks `@DuncanBetts`_. * Add hint to error message hinting possible missing __init__.py (`#478`_). Thanks `@DuncanBetts`_.
* Provide ``:ref:`` targets for ``recwarn.rst`` so we can use intersphinx referencing.
Thanks to `@dupuy`_ for the report and `@lwm`_ for the PR.
* An error message is now displayed if ``--confcutdir`` is not a valid directory, avoiding * An error message is now displayed if ``--confcutdir`` is not a valid directory, avoiding
subtle bugs (`#2078`_). subtle bugs (`#2078`_).
Thanks `@nicoddemus`_ for the PR. Thanks `@nicoddemus`_ for the PR.
@ -19,6 +22,8 @@
* *
.. _@dupuy: https://bitbucket.org/dupuy/
.. _@lwm: https://github.com/lwm
.. _@adler-j: https://github.com/adler-j .. _@adler-j: https://github.com/adler-j
.. _@DuncanBetts: https://github.com/DuncanBetts .. _@DuncanBetts: https://github.com/DuncanBetts
.. _@nedbat: https://github.com/nedbat .. _@nedbat: https://github.com/nedbat

8
doc/en/recwarn.rst
View File

@ -1,8 +1,12 @@
.. _`asserting warnings`:
.. _assertwarnings: .. _assertwarnings:
Asserting Warnings Asserting Warnings
===================================================== =====================================================
.. _`asserting warnings with the warns function`:
.. _warns: .. _warns:
Asserting warnings with the warns function Asserting warnings with the warns function
@ -46,6 +50,8 @@ Alternatively, you can examine raised warnings in detail using the
``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated ``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated
differently; see :ref:`ensuring_function_triggers`. differently; see :ref:`ensuring_function_triggers`.
.. _`recording warnings`:
.. _recwarn: .. _recwarn:
Recording warnings Recording warnings
@ -96,6 +102,8 @@ class of the warning. The ``message`` is the warning itself; calling
``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated ``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated
differently; see :ref:`ensuring_function_triggers`. differently; see :ref:`ensuring_function_triggers`.
.. _`ensuring a function triggers a deprecation warning`:
.. _ensuring_function_triggers: .. _ensuring_function_triggers:
Ensuring a function triggers a deprecation warning Ensuring a function triggers a deprecation warning