From b2a7a262977391a09a49295dec4bebe0a120e316 Mon Sep 17 00:00:00 2001
From: Shashwat Agrawal <72117025+ShashwatAgrawal20@users.noreply.github.com>
Date: Tue, 4 Feb 2025 23:20:48 +0530
Subject: [PATCH] DOC: `pandas.DataFrame.to_html` additional description for
the border parameter (#60830)
* should work
* fix: proper backticks
---
pandas/core/frame.py | 10 +++++++---
pandas/io/formats/format.py | 10 +++++++---
2 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/pandas/core/frame.py b/pandas/core/frame.py
index d9f7623064e05..b715e526e0f33 100644
--- a/pandas/core/frame.py
+++ b/pandas/core/frame.py
@@ -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
- `
` 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 ```` 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 `` tag if specified.
render_links : bool, default False
diff --git a/pandas/io/formats/format.py b/pandas/io/formats/format.py
index 46ecb2b9a8f12..b7fbc4e5e22b7 100644
--- a/pandas/io/formats/format.py
+++ b/pandas/io/formats/format.py
@@ -897,9 +897,13 @@ def to_html(
```` 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
- ```` 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 ```` 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 `` tag if specified.
render_links : bool, default False