Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Function signatures look untidy #2294

Open
d-v-b opened this issue Oct 2, 2024 · 0 comments
Open

DOC: Function signatures look untidy #2294

d-v-b opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic

Comments

@d-v-b
Copy link
Contributor

d-v-b commented Oct 2, 2024

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.

@d-v-b d-v-b added help wanted Issue could use help from someone with familiarity on the topic documentation Improvements to the documentation labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation help wanted Issue could use help from someone with familiarity on the topic
Projects
None yet
Development

No branches or pull requests

1 participant