graspologic-org / graspologic

Python package for graph statistics

Home Page:https://graspologic-org.github.io/graspologic/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

bdpedigo opened this issue · comments

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

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