DOC: Function signatures look untidy #2294
Labels
documentation
Improvements to the documentation
help wanted
Issue could use help from someone with familiarity on the topic
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.
The text was updated successfully, but these errors were encountered: