Skip to content

Commit e271ff8

Browse files
committed
Add descriptions and tags usage examples to README
1 parent 14ba685 commit e271ff8

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.rst

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ The following parapmeters are optional:
5757
- :code:`rp_launch_description = 'Smoke test'` - launch description
5858

5959

60-
Logging
61-
~~~~~~~
60+
Examples
61+
~~~~~~~~
6262

6363
For logging of the test item flow to Report Portal, please, use the python
64-
logging handler privided by plugin like bellow:
64+
logging handler provided by plugin like bellow:
6565

6666
.. code-block:: python
6767
@@ -102,6 +102,28 @@ logging handler privided by plugin like bellow:
102102
# This debug message will not be sent to the Report Portal.
103103
logger.debug("Case1. Debug message")
104104
105+
Plugin can report doc-strings of tests as :code:`descriptions`:
106+
107+
.. code-block:: python
108+
109+
def test_one():
110+
"""
111+
Description of the test case which will be sent to Report Portal
112+
"""
113+
pass
114+
115+
Pytest markers will be attached as :code:`tags` to Report Portal items.
116+
In the following example tags 'linux' and 'win32' will be used:
117+
118+
.. code-block:: python
119+
120+
import pytest
121+
122+
@pytest.mark.win32
123+
@pytest.mark.linux
124+
def test_one():
125+
pass
126+
105127
106128
Launching
107129
~~~~~~~~~

0 commit comments

Comments
 (0)