-
-
Notifications
You must be signed in to change notification settings - Fork 166
Use grid-style tables for member lists #105
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
Conversation
Supports multi-line attribute descriptions (Fixes numpy#104) - Attribute type spec is now on a separate line to description
Reimplementing autosummary is going to be a bit hacky, in order to get signatures and documentation summaries right, but might still be the best approach to meet all our needs. |
I think this is a strict improvement on the status quo. But it still doesn't satisfy scikit-learn's needs. |
What needs are not met by this? The PDF issue? |
out += [hdr] | ||
desc = [param_type, ''] + desc | ||
table.append(["**" + param.strip() + "**", desc]) | ||
out += ['', ''] + _grid_table_rst(table) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the reason to use grid tables? simple tables are supposed to support multi-line rows:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables
(unless that might be too fragile?)
yes, apparently you're right that i misunderstood and didn't need to use
grid tables.
yes, pdf support is the only downside of this relative to the status quo.
Should we find a to remove the table from the grid search docs?
to the ideal:
* attribute and method listings still look different to parameter listings.
* autosummary will still appear in a separate table whose columns aren't
aligned with this one.
|
Off topic: It would be great if github's email detection would be better. Or maybe there's something you could change about your email formatting? Having the the full quote on the website sometimes makes me overlook parts that you actually wrote. I can live with the sub-ideal points if the alternative is touching autosummary. I think using the other table format might make this PR a bit lighter. |
We could move the table to the notes or the top level section? |
Unfortunately the Gmail client on Android makes it quite hard to delete the
quoted email as far as I can tell
|
Nice :)
Sent from phone. Please excuse spelling and brevity.
|
Thanks. I didn't receive visual cues to suggest that long-tapping might
work.
…On 2 August 2017 at 08:37, Andreas Mueller ***@***.***> wrote:
Nice :)
Sent from phone. Please excuse spelling and brevity.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#105 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAEz63tVHiP70nTyywUFtTttR6zcgHRJks5sT6iigaJpZM4Oh7nZ>
.
|
Closing following merge of #106 |
However: this causes the PDF build for scikit-learn to fail:
IIUC, the main reason to be using tables rather than definition lists is for consistency with the autosummary listing. Is there any problem with reimplementing the autosummary listing as a definition list? If we don't have
.. autosummary
will the doc pages for attributes not be generated?Ping @amueller