Incorrect Rendering of the Return Section of Google Style Docstrings with Type Annotations Inside

[wonder-perfect]

Environment data

• Language Server version: 2024.11.3
• OS and version: win32 x64
• Python version (and distribution if applicable, e.g. Anaconda):
• python.analysis.indexing: true
• python.analysis.typeCheckingMode: basic

Code Snippet

def add(a: int | float, b: int | float = 0) -> int | float:
    """Add two numbers together

    Args:
        a (int | float): The first number
        b (int | float, optional): The second number. Defaults to 0.

    Returns:
        int | float: The sum of the two numbers

    Raises:
        TypeError: A parameter is not type int
        ValueError: foo
    """
    return a + b

add(1, 2)

Repro Steps

1. Open a python file using vscode
2. Install basic python support extensions: Pylance Python Python Debugger
3. Define a function with Google style docstring just like the code snippets above, and then invoke it
4. Hover on the function call to see the popup

Expected behavior

**Returns**
    **out**
    _int | float_: The sum of the two numbers

Actual behavior

Logs

2024-11-30 21:54:50.481 [info] [Info  - 9:54:50 PM] (4896) [id_0] Logging started
2024-11-30 21:54:50.701 [info] [Info  - 9:54:50 PM] (4896) Found 2 source files
2024-11-30 21:54:50.921 [info] [Error - 9:54:50 PM] (4896) File or directory "\<default workspace root>" does not exist.
2024-11-30 21:54:50.921 [info] [Info  - 9:54:50 PM] (4896) No source files found.
2024-11-30 21:54:54.244 [info] [Info  - 9:54:54 PM] Server process exited successfully
2024-11-30 21:54:54.771 [info] (Client) Pylance async client (2024.11.3) started with python extension (2024.20.0)
2024-11-30 21:54:56.488 [info] [Info  - 9:54:56 PM] (13468) Server root directory: file:///c%3A/Users/username/.vscode/extensions/ms-python.vscode-pylance-2024.11.3/dist
2024-11-30 21:54:56.491 [info] [Info  - 9:54:56 PM] (13468) Pylance language server 2024.11.3 (pyright version 1.1.386, commit 4180fa21) starting
2024-11-30 21:54:56.498 [info] [Info  - 9:54:56 PM] (13468) Starting service instance "dev"
2024-11-30 21:54:56.543 [info] [Info  - 9:54:56 PM] (13468) Setting environmentName for service "dev": "3.10.11 (global)"
2024-11-30 21:54:56.543 [info] [Info  - 9:54:56 PM] (13468) Setting pythonPath for service "dev": "C:\Users\username\AppData\Local\Programs\Python\Python310\python.exe"
2024-11-30 21:54:56.544 [info] [Info  - 9:54:56 PM] (13468) No include entries specified; assuming d:\Project\dev
2024-11-30 21:54:56.546 [info] [Info  - 9:54:56 PM] (13468) Auto-excluding **/node_modules
2024-11-30 21:54:56.547 [info] [Info  - 9:54:56 PM] (13468) Auto-excluding **/__pycache__
2024-11-30 21:54:56.547 [info] [Info  - 9:54:56 PM] (13468) Auto-excluding **/.*
2024-11-30 21:54:56.656 [info] [Info  - 9:54:56 PM] (13468) Assuming Python version 3.10.11.final.0
2024-11-30 21:54:56.938 [info] [Info  - 9:54:56 PM] (13468) Found 2 source files
2024-11-30 21:54:57.520 [info] [Info  - 9:54:57 PM] (13468) Background analysis(1) root directory: file:///c%3A/Users/username/.vscode/extensions/ms-python.vscode-pylance-2024.11.3/dist
2024-11-30 21:54:57.525 [info] [Info  - 9:54:57 PM] (13468) Background analysis(1) started
2024-11-30 21:54:57.800 [info] [Info  - 9:54:57 PM] (13468) Indexer background runner(2) root directory: file:///c%3A/Users/username/.vscode/extensions/ms-python.vscode-pylance-2024.11.3/dist (index)
2024-11-30 21:54:57.800 [info] [Info  - 9:54:57 PM] (13468) Indexing(2) started
2024-11-30 21:54:59.986 [info] [Info  - 9:54:59 PM] (13468) scanned(2) 390 files over 1 exec env
2024-11-30 21:55:06.656 [info] [Info  - 9:55:06 PM] (13468) [IDX(2)] Long operation: index execution environment file:///d%3A/to/workspace (6257ms)
2024-11-30 21:55:06.858 [info] [Info  - 9:55:06 PM] (13468) [IDX(2)] Long operation: index packages file:///d%3A/to/workspace (6499ms)
2024-11-30 21:55:06.858 [info] [Info  - 9:55:06 PM] (13468) indexed(2) 390 files over 1 exec env
2024-11-30 21:55:07.081 [info] [Info  - 9:55:07 PM] (13468) Indexing finished(2).

Addtional Info

Seems to be related to #6127 , but slightly different. The bugs in #6127 were fixed, but there are new ones here.

[KacieKK]

Thanks for posting this issue. I can reproduce it.

[EliasRas]

I encountered a similar (same?) issue with numpy style docstrings. dict of is incorrectly parsed as the name of the return value.

Using the same format as in the type hint works. I guess the issue has something to do with the combination of spaces and ().

Everything works if I switch off the preview feature python.analysis.supportRestructuredText.

# Does not work
def example() -> dict[str, int]:
    """
    Demonstrate rendering.

    Returns
    -------
    dict of (str, int)
        Incorrectly rendered type hint.
    """

    return {"key": 1}

# Works
def example() -> dict[str, int]:
    """
    Demonstrate rendering.

    Returns
    -------
    dict[str, int]
        Incorrectly rendered type hint.
    """

    return {"key": 1}

[Zoraiyo]

This rendering error still occurs with "Pylance async client (2025.2.1) started with python extension (2025.0.0)" and enabled "python.analysis.supportRestructuredText".

def example(a: str, b: int) -> tuple[str, dict[str, int]]:
    """Example function with type hints.

    Args:
        a (str): Example input string
        b (int): Example input integer

    Returns:
        tuple[str, dict[str, int]]: Example output tuple
    """
    return a, {"b": b}