Skip to content

Docstring generated for sync and asyncio have incorrect return type #616

Closed
@m3brown

Description

@m3brown

Describe the bug
The sync_detailed and asyncio_detailed functions return type Response[...]

The non-detailed sync and asyncio functions return Response.parsed

The docstrings do not reflect this, though, because Response[...] is hard coded into the template used for generating the docstring for both functions.

This results in generated code where the type hint return type (Optional) is the not same as the docstring return type (Response)

def sync(
    account_id: str,
    *,
    client: AuthenticatedClient,
) -> Optional[Union[Any, ProblemDetails, UserDto]]:
    """Lookup user by accountId. (Auth policies: user)
    Args:
        account_id (str):
    Returns:
        Response[Union[Any, ProblemDetails, UserDto]]
    """

    return sync_detailed(
        account_id=account_id,
        client=client,
    ).parsed

To Reproduce
TODO

Expected behavior
The doctstring return type is identical to the type hint

OpenAPI Spec File
TODO

Desktop (please complete the following information):

  • OS: Mac OS 12.3.1
  • Python Version: 3.9.11
  • openapi-python-client version: 0.11.1

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    🐞bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions