Skip to content

_str_members_list mishandles multi-line descriptions #104

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.

Sign up for GitHub

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

Jump to bottom
Closed
jnothman opened this issue Jul 24, 2017 · 2 comments
Closed

_str_members_list mishandles multi-line descriptions #104

jnothman opened this issue Jul 24, 2017 · 2 comments

Comments

@jnothman
Copy link
Member

http://scikit-learn.org/dev/modules/generated/sklearn.model_selection.GridSearchCV.html under "Attributes" shows an example where a table is included in the attribute description. But _str_members_list destroys any layout here.

Does anyone know why multiple lines of description are flattened?
@jnothman jnothman mentioned this issue Jul 24, 2017
Merged
@jnothman
Copy link
Member Author

1k words:

screen shot 2017-07-24 at 2 35 42 pm

@jnothman
Copy link
Member Author

Was:

screen shot 2017-07-24 at 2 37 40 pm

jnothman added a commit to jnothman/numpydoc that referenced this issue Jul 25, 2017
@jnothman
Use grid-style tables for member lists
e0ba4f2 
Supports multi-line attribute descriptions (Fixes numpy#104)

- Attribute type spec is now on a separate line to description
@jnothman jnothman mentioned this issue Jul 25, 2017
Closed
@amueller amueller mentioned this issue Aug 4, 2017
Closed
@jnothman jnothman mentioned this issue Aug 7, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jnothman