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

attribute names with trailing underscores are not references #62

Closed
amueller opened this issue Sep 7, 2016 · 1 comment
Closed

attribute names with trailing underscores are not references #62

amueller opened this issue Sep 7, 2016 · 1 comment

Comments

@amueller
Copy link
Contributor

amueller commented Sep 7, 2016

This is more of a question.
In scikit-learn we name out attributes with trailing underscores like

Attributes
==========
bla_ : ndarray
   Nothing useful

I remember that at some point, we needed to enclose the attribute in backticks to not get an error about undefined references. Then at some point, we didn't need to do that any more. I just upgraded us to numpydoc master, and now I have to add the backticks in a gain.
Were there any intentional changes in that? It's also possible that we hacked this somewhere ourselves, but I can't find the relevant change in the code :(

@amueller
Copy link
Contributor Author

amueller commented Sep 7, 2016

I think this is because attribute descriptions used to be generated by SphinxDocString._str_param_list but now they are generated by SphinxDocStr._str_member_list. I'm not entirely sure what the difference is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants