Skip to content

Commit a4a8763

Browse files
committed
Consistently add **Tutorial**: in front of how-to links in reference
Up to now, some had the prefix, some didn't. I think it's good to have this prefix to give more context, otherwise the links sometimes blend into the description. In one case, the link goes to an example, so I used `**Example**:` there.
1 parent db13930 commit a4a8763

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

doc/en/reference/reference.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -92,23 +92,23 @@ pytest.param
9292
pytest.raises
9393
~~~~~~~~~~~~~
9494

95-
**Tutorial**: :ref:`assertraises`.
95+
**Tutorial**: :ref:`assertraises`
9696

9797
.. autofunction:: pytest.raises(expected_exception: Exception [, *, match])
9898
:with: excinfo
9999

100100
pytest.deprecated_call
101101
~~~~~~~~~~~~~~~~~~~~~~
102102

103-
**Tutorial**: :ref:`ensuring_function_triggers`.
103+
**Tutorial**: :ref:`ensuring_function_triggers`
104104

105105
.. autofunction:: pytest.deprecated_call()
106106
:with:
107107

108108
pytest.register_assert_rewrite
109109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110110

111-
**Tutorial**: :ref:`assertion-rewriting`.
111+
**Tutorial**: :ref:`assertion-rewriting`
112112

113113
.. autofunction:: pytest.register_assert_rewrite
114114

@@ -123,7 +123,7 @@ pytest.warns
123123
pytest.freeze_includes
124124
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125125

126-
**Tutorial**: :ref:`freezing-pytest`.
126+
**Tutorial**: :ref:`freezing-pytest`
127127

128128
.. autofunction:: pytest.freeze_includes
129129

@@ -143,7 +143,7 @@ fixtures or plugins.
143143
pytest.mark.filterwarnings
144144
~~~~~~~~~~~~~~~~~~~~~~~~~~
145145

146-
**Tutorial**: :ref:`filterwarnings`.
146+
**Tutorial**: :ref:`filterwarnings`
147147

148148
Add warning filters to marked test items.
149149

@@ -169,7 +169,7 @@ Add warning filters to marked test items.
169169
pytest.mark.parametrize
170170
~~~~~~~~~~~~~~~~~~~~~~~
171171

172-
:ref:`parametrize`.
172+
**Tutorial**: :ref:`parametrize`
173173

174174
This mark has the same signature as :py:meth:`pytest.Metafunc.parametrize`; see there.
175175

@@ -179,7 +179,7 @@ This mark has the same signature as :py:meth:`pytest.Metafunc.parametrize`; see
179179
pytest.mark.skip
180180
~~~~~~~~~~~~~~~~
181181

182-
:ref:`skip`.
182+
**Tutorial**: :ref:`skip`
183183

184184
Unconditionally skip a test function.
185185

@@ -193,7 +193,7 @@ Unconditionally skip a test function.
193193
pytest.mark.skipif
194194
~~~~~~~~~~~~~~~~~~
195195

196-
:ref:`skipif`.
196+
**Tutorial**: :ref:`skipif`
197197

198198
Skip a test function if a condition is ``True``.
199199

@@ -209,7 +209,7 @@ Skip a test function if a condition is ``True``.
209209
pytest.mark.usefixtures
210210
~~~~~~~~~~~~~~~~~~~~~~~
211211

212-
**Tutorial**: :ref:`usefixtures`.
212+
**Tutorial**: :ref:`usefixtures`
213213

214214
Mark a test function as using the given fixture names.
215215

@@ -231,7 +231,7 @@ Mark a test function as using the given fixture names.
231231
pytest.mark.xfail
232232
~~~~~~~~~~~~~~~~~~
233233

234-
**Tutorial**: :ref:`xfail`.
234+
**Tutorial**: :ref:`xfail`
235235

236236
Marks a test function as *expected to fail*.
237237

@@ -297,7 +297,7 @@ When :meth:`Node.iter_markers <_pytest.nodes.Node.iter_markers>` or :meth:`Node.
297297
Fixtures
298298
--------
299299

300-
**Tutorial**: :ref:`fixture`.
300+
**Tutorial**: :ref:`fixture`
301301

302302
Fixtures are requested by test functions or other fixtures by declaring them as argument names.
303303

@@ -338,7 +338,7 @@ For more details, consult the full :ref:`fixtures docs <fixture>`.
338338
config.cache
339339
~~~~~~~~~~~~
340340

341-
**Tutorial**: :ref:`cache`.
341+
**Tutorial**: :ref:`cache`
342342

343343
The ``config.cache`` object allows other plugins and fixtures
344344
to store and retrieve values across test runs. To access it from fixtures
@@ -358,7 +358,7 @@ Under the hood, the cache plugin uses the simple
358358
capsys
359359
~~~~~~
360360

361-
:ref:`captures`.
361+
**Tutorial**: :ref:`captures`
362362

363363
.. autofunction:: _pytest.capture.capsys()
364364
:no-auto-options:
@@ -383,7 +383,7 @@ capsys
383383
capsysbinary
384384
~~~~~~~~~~~~
385385

386-
:ref:`captures`.
386+
**Tutorial**: :ref:`captures`
387387

388388
.. autofunction:: _pytest.capture.capsysbinary()
389389
:no-auto-options:
@@ -405,7 +405,7 @@ capsysbinary
405405
capfd
406406
~~~~~~
407407

408-
:ref:`captures`.
408+
**Tutorial**: :ref:`captures`
409409

410410
.. autofunction:: _pytest.capture.capfd()
411411
:no-auto-options:
@@ -427,7 +427,7 @@ capfd
427427
capfdbinary
428428
~~~~~~~~~~~~
429429

430-
:ref:`captures`.
430+
**Tutorial**: :ref:`captures`
431431

432432
.. autofunction:: _pytest.capture.capfdbinary()
433433
:no-auto-options:
@@ -449,7 +449,7 @@ capfdbinary
449449
doctest_namespace
450450
~~~~~~~~~~~~~~~~~
451451

452-
:ref:`doctest`.
452+
**Tutorial**: :ref:`doctest`
453453

454454
.. autofunction:: _pytest.doctest.doctest_namespace()
455455

@@ -469,7 +469,7 @@ doctest_namespace
469469
request
470470
~~~~~~~
471471

472-
:ref:`request example`.
472+
**Example**: :ref:`request example`
473473

474474
The ``request`` fixture is a special fixture providing information of the requesting test function.
475475

@@ -490,7 +490,7 @@ pytestconfig
490490
record_property
491491
~~~~~~~~~~~~~~~~~~~
492492

493-
**Tutorial**: :ref:`record_property example`.
493+
**Tutorial**: :ref:`record_property example`
494494

495495
.. autofunction:: _pytest.junitxml.record_property()
496496

@@ -500,7 +500,7 @@ record_property
500500
record_testsuite_property
501501
~~~~~~~~~~~~~~~~~~~~~~~~~
502502

503-
**Tutorial**: :ref:`record_testsuite_property example`.
503+
**Tutorial**: :ref:`record_testsuite_property example`
504504

505505
.. autofunction:: _pytest.junitxml.record_testsuite_property()
506506

@@ -510,7 +510,7 @@ record_testsuite_property
510510
caplog
511511
~~~~~~
512512

513-
:ref:`logging`.
513+
**Tutorial**: :ref:`logging`
514514

515515
.. autofunction:: _pytest.logging.caplog()
516516
:no-auto-options:
@@ -526,7 +526,7 @@ caplog
526526
monkeypatch
527527
~~~~~~~~~~~
528528

529-
:ref:`monkeypatching`.
529+
**Tutorial**: :ref:`monkeypatching`
530530

531531
.. autofunction:: _pytest.monkeypatch.monkeypatch()
532532
:no-auto-options:
@@ -612,7 +612,7 @@ Each recorded warning is an instance of :class:`warnings.WarningMessage`.
612612
tmp_path
613613
~~~~~~~~
614614

615-
:ref:`tmp_path`
615+
**Tutorial**: :ref:`tmp_path`
616616

617617
.. autofunction:: _pytest.tmpdir.tmp_path()
618618
:no-auto-options:
@@ -623,7 +623,7 @@ tmp_path
623623
tmp_path_factory
624624
~~~~~~~~~~~~~~~~
625625

626-
:ref:`tmp_path_factory example`
626+
**Tutorial**: :ref:`tmp_path_factory example`
627627

628628
.. _`tmp_path_factory factory api`:
629629

@@ -638,7 +638,7 @@ tmp_path_factory
638638
tmpdir
639639
~~~~~~
640640

641-
:ref:`tmpdir and tmpdir_factory`
641+
**Tutorial**: :ref:`tmpdir and tmpdir_factory`
642642

643643
.. autofunction:: _pytest.legacypath.LegacyTmpdirPlugin.tmpdir()
644644
:no-auto-options:
@@ -649,7 +649,7 @@ tmpdir
649649
tmpdir_factory
650650
~~~~~~~~~~~~~~
651651

652-
:ref:`tmpdir and tmpdir_factory`
652+
**Tutorial**: :ref:`tmpdir and tmpdir_factory`
653653

654654
``tmpdir_factory`` is an instance of :class:`~pytest.TempdirFactory`:
655655

@@ -662,7 +662,7 @@ tmpdir_factory
662662
Hooks
663663
-----
664664

665-
:ref:`writing-plugins`.
665+
**Tutorial**: :ref:`writing-plugins`
666666

667667
.. currentmodule:: _pytest.hookspec
668668

0 commit comments

Comments
 (0)