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

[BUG] "Parameters" showing up twice in docs for class methods #924

Open
bdpedigo opened this issue Feb 11, 2022 · 1 comment
Open

[BUG] "Parameters" showing up twice in docs for class methods #924

bdpedigo opened this issue Feb 11, 2022 · 1 comment
Labels
bug Something isn't working docs

Comments

@bdpedigo
Copy link
Collaborator

Screen Shot 2022-02-11 at 8 53 40 AM

Somehow changes in #907 made it so that "parameters" shows up twice, once from the type hints and once from what we wrote in the doc string. Doesn't feel like a huge deal but we should probably not have that

@bdpedigo bdpedigo added bug Something isn't working docs labels Feb 11, 2022
@daxpryce
Copy link
Contributor

Yeah, it's enabled on https://github.com/microsoft/graspologic/blob/dev/docs/conf.py#L73, which pulled the types out of the signature (thought it would make it more readable) - which I'd contend it does, for the signature portion - but not the parameters portion at all? So it's easy to disable, just remove that line and it'll go back to ye olden ways

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs
Projects
None yet
Development

No branches or pull requests

2 participants