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

Docs: do not show argument types in function signature #71

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

gipert
Copy link
Member

@gipert gipert commented Nov 7, 2024

No description provided.

@ManuelHu
Copy link
Collaborator

ManuelHu commented Nov 8, 2024

We will need more work to make this look nice.
At the moment we have a lot of parameters that are undocumented (i.e. they have no docstring). But their usage is still clear from the context if one knows the type. (i.e. the λ parameter, when one knows to pass a Quantity)

And with autodoc_typehints = "description", their type is not part of the docs at all. And I would also not really like if we would have to repeat a verbose docstring that the user has to pass a wavelength array multiple times...

@gipert
Copy link
Member Author

gipert commented Nov 9, 2024

Ok, I see your point. We can revert it to how it was before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants