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.

Sign up for GitHub

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

Jump to bottom

Function class documentation in Sphinx don't show parameters #17598

Open
asmeurer opened this issue Sep 9, 2019 · 1 comment
Open

Function class documentation in Sphinx don't show parameters #17598

asmeurer opened this issue Sep 9, 2019 · 1 comment
Labels
Documentation GSoD
Milestone
Docstring Style G...

Comments

@asmeurer
Copy link
Member

asmeurer commented Sep 9, 2019

For example at https://docs.sympy.org/dev/modules/functions/special.html. It says things like

class sympy.functions.special.delta_functions.DiracDelta

It would be better if it said

class sympy.functions.special.delta_functions.DiracDelta(arg, k=0)

I don't know how easy it is to fix. We already define __signature__ so maybe it's a Sphinx issue that it should be reading that.

CC @sympy/gsod
@asmeurer asmeurer added this to the Docstring Style Guide milestone Sep 23, 2019
@Nibba2018
Copy link

Nibba2018 commented Feb 9, 2020 •
edited

@asmeurer Is this issue still up?

@asmeurer asmeurer added the GSoD label Mar 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation GSoD
Projects
None yet
Milestone
Docstring Style Guide
Development

No branches or pull requests
2 participants
@asmeurer @Nibba2018