How to insert a blank line?

[andreas-vester]

Add detailed information, like

• mkdocstrings version: 0.19.0

How can I put some text in my docstring to a new line?

def docstest(int_val: int) -> int:
    """Function to showcase docstring problems.

    Parameters
    ----------
    int_val
        Integer value.
        This text should be in a new line. How can I do that?

    Returns
    -------
    int:
        Returns an integer value

    """
    pass

[pawamoy]

Two solutions:

• add two trailing spaces to the previous line
• use <br> to insert line breaks

[andreas-vester]

Two solutions:

* add two trailing spaces to the previous line

Trailing spaces will automatically be removed by using the black formatter.

* use `<br>` to insert line breaks

This seems to be working, however, it pollutes the docstring. For example, using help(doctest) on the command line will now reveal the <br> command.

Inserting a blank line in the docstring seems to be translated to a regular new line when generating the online docs using mkdocstrings.

[pawamoy]

Trailing spaces will automatically be removed by using the black formatter.

Could you see if there's an issue for this on their tracker? And otherwise open one?

[pawamoy]

Found one: psf/black#3306

[pawamoy]

The CommonMark spec says that we can use a backslash for hard line breaks. Unfortunately it seems that Python-Markdown does not support it.

[pawamoy]

It has been asked before: Python-Markdown/markdown#1157.
Suggested solution: use the pymdownx.escapeall extension, with the hardbreak option enabled:

markdown_extensions:
- pymdownx.escapeall:
    hardbreak: yes