ENH: add long and short captions to Styler.to_latex
#41659
Conversation
Styler.to_latex
|
|
||
| def test_long_captions(styler): | ||
| result = styler.to_latex(caption=("short cap", "long cap")) | ||
| assert "\\caption[short cap]{long cap}" in result |
There was a problem hiding this comment.
Can you replicate the existing behavior as here https://github.com/pandas-dev/pandas/pull/35668/files?
Currently in DataFrame.to_latex we can pass a string full_caption or a tuple (full_caption, short_caption).
In your code it is vice versa (short_caption, full_caption).
Also I would rename this test function to test_short_caption, since it targets a feature of adding a short caption.
In addition, you would need to change the indices in the docstring as well.
There was a problem hiding this comment.
good catch. easy fix. should be ok now.
| \caption{% raw %}{{% endraw %}{{caption}}{% raw %}}{% endraw %} | ||
|
|
||
| {% elif caption and caption is sequence %} | ||
| \caption[{{caption[1]}}]{% raw %}{{% endraw %}{{caption[0]}}{% raw %}}{% endraw %} |
There was a problem hiding this comment.
Please keep in mind that the same behavior should be implemented for longtable (once the longtables are implemented through the styler).
# Conflicts: # pandas/io/formats/templates/html.tpl # pandas/tests/io/formats/style/test_style.py
| @@ -87,8 +87,8 @@ class Styler(StylerRenderer): | |||
| List of {selector: (attr, value)} dicts; see Notes. | |||
| uuid : str, default None | |||
| A unique identifier to avoid CSS collisions; generated automatically. | |||
| caption : str, default None | |||
| Caption to attach to the table. | |||
| caption : str, tuple, default None | |||
There was a problem hiding this comment.
would emphasize here and below tht this is (full caption, short caption)
|
thanks |
completes an item on the list for
DataFrame.to_latexdeprecation #41649