Test docstrings are not rendered in the report in a consistent way about allure-python HOT 2 OPEN

It's actually pretty consistent, just not in the intuitive way. Allure renders a description as markdown. Here are several examples:

Paragraph

In your first example the docstring is just a line of text. It's rendered as a paragraph:

Python:

def test_1():
    """First description"""

Docstring value:

First description

Rendered description:

Block code

The second example has a docstring consisting of three lines. The first and the last lines are essentially empty and are ignored. The second line is prepended by four spaces, hence is rendered as a block code:

Python:

def test_2():
    """
    Second description
    """

Docstring value:

    Second description
    

Rendered description:

Complex description

Now, as you see how it works, it's easy to put something even more complicated into the docstring.

Python:

def test_3():
    """The next line will appear as a block code:

    This is rendered as a block code.

This is a table:

| Name | ID  |
| ---- | --- |
| John | 1   |
| Jane | 2   |

    """

Docstring value:

The next line will appear as a block code:

    This is rendered as a block code.

This is a table:

| Name | ID  |
| ---- | --- |
| John | 1   |
| Jane | 2   |

    

Rendered description:

So it's pretty consistent. It's just that raw markdown isn't that convenient to be put in python docstrings. As you see, it makes docstrings quite ugly.

I think we may try to dedent docstrings before putting them to the test's description, so that the third example could be written like this:

def test_3():
    """
    The next line will appear as a block code:
    
    This is rendered as a block code.
    
    This is a table:
    
    | Name | ID  |
    | ---- | --- |
    | John | 1   |
    | Jane | 2   |

    """

That will help making the whole thing more predictable and user-friendly.

from allure-python.

I think we may try to dedent docstrings before putting them to the test's description

@delatrie Please do! I've been working w/ Allure for several months now and it was nagging at me that we couldn't have formatted text from the docstring, never imagining I needed to dedent! Don't remember seeing this info in any documentation.

Dedenting in code is quite counter-intuitive and doesn't really follow Python aesthetics. Also, some linters like black auto-indent (ie, insert indentation), which makes use of these linters harder or impossible (black doesn't have an option to not indent docstrings).

Dendenting in Allure, like you suggested, would be the way to go.

from allure-python.