Newline character in doctstring not supported

My docstrings Examples have string arguments containing newline characters. Despite being placed inside a code section, they are broken:

class WikiPage():
  """
  The class for a Gitlab Wiki page. This class is used to handle a local copy of the wiki repository file (i.e., a wiki page gitlab.v4.objects.ProjectWiki or one of gitlab.v4.objects.Project.wikis)

  \```
    {
      'content' = '# My content with newlines\n\n',
      'format' = 'markdown',
  ...
  \```

Further, Examples (google-style) are broken as well:

here’s my YAML file:

# mkdocs.yml
site_name: Grafana Wiki
theme:
  name: "material"

markdown_extensions:
  - pymdownx.arithmatex

plugins:
  - mkdocstrings:
      handlers:
        python:
          docstring_style: "google"
          docstring_options: "true"
          setup_commands:
            - import sys
            - sys.path.append("..")
      watch:
        - ..

# index.md

::: WikiPage:WikiPage
    handler: "python"

[pawamoy]

In the end I will close this as there’s nothing we can do: it’s how Python works. Consider this:

In [1]: """first line
   ...: second line\nthird line
   ...: fourth line"""
Out[1]: 'first line\nsecond line\nthird line\nfourth line'

To Pyhon, your \n is not any different than a literal new line. \n is, actually, a new line character.

Two workarounds:

• escape your newline characters:

class WikiPage:
    """
    ```
      {
        'content' = '# My content with newlines\\n\\n',
        'format' = 'markdown',
        ...
    ```
    """

• mark your docstring as “raw”:

class WikiPage:
    r"""
    ```
      {
        'content' = '# My content with newlines\n\n',
        'format' = 'markdown',
        ...
    ```
    """

Feel free to further comment on this 🙂

[justinTM]

i’ll go with raw thank you for your help!