Skip to content

DOC: Function signatures look untidy #2294

Open
@d-v-b

Description

@d-v-b

Describe the issue linked to the documentation

The function signatures in our docs are hard to read. See this example.

image

Suggested fix for documentation

Long function signatures should be easy to read. I have experience with the mkdocstrings package for mkdocs, that produces much more readable function signatures. See this example from pydantic:

image

It's long, but much more readable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions