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
Moving Constructor definition to the top like a Function definition #5103
Comments
Hum... even wondering if this is not a regression... |
I don't think this is a regression - I think we've always printed the class docstring above the constructor info. We have to guess what is most likely to be useful to the user, and it's not clear that putting constructor info above the class docstring is better. |
Oh, I read it was the constructor signature. Maybe we can peek at which one have the less lines. If constructor have less lines, it is probably just info on the signature right ? |
It is constructor signature in the example shown, but we group constructor info - docstring, signature, etc. - together. |
#5285 makes the proposed change, and should improve the output for classes and callable objects |
I would like to know if there is any specific reason for displaying the constructor definition at the bottom unlike a normal function definition. Currently it is less user-friendly to check up the default values of the arguments in the constructor. For example : scikit-image/scikit-image#885 (comment)
The text was updated successfully, but these errors were encountered: