Skip to content

Commit

Permalink
DOC: pandas.DataFrame.to_html additional description for the border…
Browse files Browse the repository at this point in the history
… parameter (#60830)

* should work

* fix: proper backticks
  • Loading branch information
ShashwatAgrawal20 authored Feb 4, 2025
1 parent e830603 commit b2a7a26
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
10 changes: 7 additions & 3 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -3205,9 +3205,13 @@ def to_html(
Convert the characters <, >, and & to HTML-safe sequences.
notebook : {True, False}, default False
Whether the generated HTML is for IPython Notebook.
border : int
A ``border=border`` attribute is included in the opening
`<table>` tag. Default ``pd.options.display.html.border``.
border : int or bool
When an integer value is provided, it sets the border attribute in
the opening tag, specifying the thickness of the border.
If ``False`` or ``0`` is passed, the border attribute will not
be present in the ``<table>`` tag.
The default value for this parameter is governed by
``pd.options.display.html.border``.
table_id : str, optional
A css id is included in the opening `<table>` tag if specified.
render_links : bool, default False
Expand Down
10 changes: 7 additions & 3 deletions pandas/io/formats/format.py
Original file line number Diff line number Diff line change
Expand Up @@ -897,9 +897,13 @@ def to_html(
``<table>`` tag, in addition to the default "dataframe".
notebook : {True, False}, optional, default False
Whether the generated HTML is for IPython Notebook.
border : int
A ``border=border`` attribute is included in the opening
``<table>`` tag. Default ``pd.options.display.html.border``.
border : int or bool
When an integer value is provided, it sets the border attribute in
the opening tag, specifying the thickness of the border.
If ``False`` or ``0`` is passed, the border attribute will not
be present in the ``<table>`` tag.
The default value for this parameter is governed by
``pd.options.display.html.border``.
table_id : str, optional
A css id is included in the opening `<table>` tag if specified.
render_links : bool, default False
Expand Down

0 comments on commit b2a7a26

Please sign in to comment.