Skip to content
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.

Sign up for GitHub

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

DOC: pandas.DataFrame.to_html additional description for the border parameter #60830

Merged
merged 3 commits into from
Feb 4, 2025
Merged

DOC: pandas.DataFrame.to_html additional description for the border parameter #60830

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a57cd44
should work
ShashwatAgrawal20 Feb 2, 2025
c4f6a02
fix: proper backticks
ShashwatAgrawal20 Feb 4, 2025
df157aa
Merge remote-tracking branch 'upstream/main' into doc_60148
ShashwatAgrawal20 Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions pandas/core/frame.py
View file
Open in desktop
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 (zero)`` is passed, the border attribute will not
be present in the `<table>` tag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If ``False or 0 (zero)`` is passed, the border attribute will not
be present in the `<table>` tag.
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
11 changes: 8 additions & 3 deletions pandas/io/formats/format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -897,9 +897,14 @@ 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 (zero)`` is passed, the border attribute will not
be present in the `<table>`tag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If ``False or 0 (zero)`` is passed, the border attribute will not
be present in the `<table>`tag.
If ``False`` or ``0`` is passed, the border attribute will not
be present in the ``<table>`` tag.


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

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
Loading