Skip to content

Commit b2a7a26

Browse files
DOC: pandas.DataFrame.to_html additional description for the border parameter (#60830)
* should work * fix: proper backticks
1 parent e830603 commit b2a7a26

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

pandas/core/frame.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -3205,9 +3205,13 @@ def to_html(
32053205
Convert the characters <, >, and & to HTML-safe sequences.
32063206
notebook : {True, False}, default False
32073207
Whether the generated HTML is for IPython Notebook.
3208-
border : int
3209-
A ``border=border`` attribute is included in the opening
3210-
`<table>` tag. Default ``pd.options.display.html.border``.
3208+
border : int or bool
3209+
When an integer value is provided, it sets the border attribute in
3210+
the opening tag, specifying the thickness of the border.
3211+
If ``False`` or ``0`` is passed, the border attribute will not
3212+
be present in the ``<table>`` tag.
3213+
The default value for this parameter is governed by
3214+
``pd.options.display.html.border``.
32113215
table_id : str, optional
32123216
A css id is included in the opening `<table>` tag if specified.
32133217
render_links : bool, default False

pandas/io/formats/format.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -897,9 +897,13 @@ def to_html(
897897
``<table>`` tag, in addition to the default "dataframe".
898898
notebook : {True, False}, optional, default False
899899
Whether the generated HTML is for IPython Notebook.
900-
border : int
901-
A ``border=border`` attribute is included in the opening
902-
``<table>`` tag. Default ``pd.options.display.html.border``.
900+
border : int or bool
901+
When an integer value is provided, it sets the border attribute in
902+
the opening tag, specifying the thickness of the border.
903+
If ``False`` or ``0`` is passed, the border attribute will not
904+
be present in the ``<table>`` tag.
905+
The default value for this parameter is governed by
906+
``pd.options.display.html.border``.
903907
table_id : str, optional
904908
A css id is included in the opening `<table>` tag if specified.
905909
render_links : bool, default False

0 commit comments

Comments
 (0)