Skip to content

DOC: Styler errors PR08 and PR09 #28743

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

Merged
merged 7 commits into from
Oct 2, 2019
Merged

DOC: Styler errors PR08 and PR09 #28743

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
698a121
Merge pull request #1 from pandas-dev/master
bhuvanakundumani Aug 24, 2019
a2f1890
Merge pull request #3 from pandas-dev/master
bhuvanakundumani Aug 31, 2019
44e2280
synced
Sep 4, 2019
c5c9bd8
synicing
Oct 2, 2019
6742c8e
fixed the PR08,PR09 errors
Oct 2, 2019
c55761d
changed the See Also description
Oct 2, 2019
2f93ccc
added a line before Notes
Oct 2, 2019
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
14 changes: 10 additions & 4 deletions pandas/io/formats/style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,18 @@ class Styler:
Parameters
----------
data : Series or DataFrame
Data to be styled - either a Series or DataFrame.
precision : int
precision to round floats to, defaults to pd.options.display.precision
Precision to round floats to, defaults to pd.options.display.precision.
table_styles : list-like, default None
list of {selector: (attr, value)} dicts; see Notes
List of {selector: (attr, value)} dicts; see Notes.
uuid : str, default None
a unique identifier to avoid CSS collisions; generated automatically
A unique identifier to avoid CSS collisions; generated automatically.
caption : str, default None
caption to attach to the table
Caption to attach to the table.
table_attributes : str, default None
Items that show up in the opening ``<table>`` tag
in addition to automatic (by default) id.
cell_ids : bool, default True
If True, each cell will have an ``id`` attribute in their HTML tag.
The ``id`` takes the form ``T_<uuid>_row<num_row>_col<num_col>``
Expand All @@ -77,6 +81,8 @@ class Styler:
See Also
--------
DataFrame.style
Returns a Styler object containing methods for building
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this belongs in the See Also section - is this addressing some issue?

Copy link
Contributor Author

@bhuvanakundumani bhuvanakundumani Oct 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Had this error - 'Missing description for See Also "DataFrame.style" reference'. Hence added this line of description

Copy link
Member

Choose a reason for hiding this comment

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

Oh OK thanks for clarifying. I think this is an issue with the validator as the format should match what you see in the docsring guide (specifically small description separated by a colon):

https://python-sprints.github.io/pandas/guide/pandas_docstring.html#section-5-see-also

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the changes as requested.

a styled HTML representation for the DataFrame.

Notes
-----
Expand Down