Skip to content

DOC: fix various typos in plotting documentation #51176

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 1 commit into from
Feb 5, 2023
Merged

DOC: fix various typos in plotting documentation #51176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ def hist_frame(

See Also
--------
Series.plot.hist: Make a histogram.
pandas.Series.plot.hist: Make a histogram.
Copy link
Member

Choose a reason for hiding this comment

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

This renders properly? https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.boxplot.html

Copy link
Contributor Author

@partev partev Feb 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

there are two different boxplot functions apparently. The one you linked to renders correctly. There is another one in "plotting" folder. That one is not rendering correctly: https://pandas.pydata.org/docs/dev/reference/api/pandas.plotting.boxplot.html

Copy link
Member

Choose a reason for hiding this comment

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

Ah nice catch, thx

matplotlib.pyplot.boxplot : Matplotlib equivalent plot.

Notes
Expand Down
25 changes: 13 additions & 12 deletions pandas/plotting/_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ def radviz(

Returns
-------
class:`matplotlib.axes.Axes`
:class:`matplotlib.axes.Axes`

See Also
--------
Expand Down Expand Up @@ -274,12 +274,13 @@ def andrews_curves(

Andrews curves have the functional form:

f(t) = x_1/sqrt(2) + x_2 sin(t) + x_3 cos(t) +
x_4 sin(2t) + x_5 cos(2t) + ...
.. math::
Copy link
Member

Choose a reason for hiding this comment

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

Can you show a screen shot how this renders?

Copy link
Contributor Author

@partev partev Feb 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

image

the documentation is hosted here: https://5500-partev-pandas-0g9uwimmduf.ws-us85.gitpod.io/doc/build/html/index.html

f(t) = \\frac{x_1}{\\sqrt{2}} + x_2 \\sin(t) + x_3 \\cos(t) +
x_4 \\sin(2t) + x_5 \\cos(2t) + \\cdots

Where x coefficients correspond to the values of each dimension and t is
linearly spaced between -pi and +pi. Each row of frame then corresponds to
a single curve.
Where :math:`x` coefficients correspond to the values of each dimension
and :math:`t` is linearly spaced between :math:`-\\pi` and :math:`+\\pi`.
Each row of frame then corresponds to a single curve.

Parameters
----------
Expand All @@ -302,7 +303,7 @@ def andrews_curves(

Returns
-------
class:`matplotlip.axis.Axes`
:class:`matplotlib.axes.Axes`

Examples
--------
Expand Down Expand Up @@ -369,8 +370,8 @@ def bootstrap_plot(

See Also
--------
DataFrame.plot : Basic plotting for DataFrame objects.
Series.plot : Basic plotting for Series objects.
pandas.DataFrame.plot : Basic plotting for DataFrame objects.
pandas.Series.plot : Basic plotting for Series objects.

Examples
--------
Expand Down Expand Up @@ -434,7 +435,7 @@ def parallel_coordinates(

Returns
-------
matplotlib.axis.Axes
matplotlib.axes.Axes

Examples
--------
Expand Down Expand Up @@ -485,7 +486,7 @@ def lag_plot(series: Series, lag: int = 1, ax: Axes | None = None, **kwds) -> Ax

Returns
-------
matplotlib.axis.Axes
matplotlib.axes.Axes

Examples
--------
Expand Down Expand Up @@ -529,7 +530,7 @@ def autocorrelation_plot(series: Series, ax: Axes | None = None, **kwargs) -> Ax

Returns
-------
matplotlib.axis.Axes
matplotlib.axes.Axes

Examples
--------
Expand Down