-
-
Notifications
You must be signed in to change notification settings - Fork 364
Open
Labels
documentationImprovements to the documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topicIssue could use help from someone with familiarity on the topic
Description
Describe the issue linked to the documentation
The function signatures in our docs are hard to read. See this example.

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:

It's long, but much more readable.
Metadata
Metadata
Assignees
Labels
documentationImprovements to the documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topicIssue could use help from someone with familiarity on the topic