Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
%pdoc np.ma.compress shows docstring twice #89
Original Launchpad bug 521612: https://bugs.launchpad.net/ipython/+bug/521612
No idea why, but querying np.ma.compress with ? or %pdoc double-prints the docstring, with the second copy indented.
See this numpy thread for some context:
That object has a runtime-generated docstring, but I checked and its doc is OK (no duplication there). So the bug is definitely ours.
The object implements a .getdoc() method.
Are there actually any cases where .getdoc() adds info to the normal docstring, or can we simplify it to only check .getdoc() if it doesn't get a normal docstring. Otherwise, one possible way round this is to use
That's a good point. I think it's fairly rare, so anyone implementing it must have had a good reason to do it, and we might as well honor it. Since using both is definitely a bug, I agree we could go with letting getdoc take precedence, unless what it returns is not a string, case in which we fall back to