Skip to content

DOC: added plotting module to the api reference docs #19780

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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
18 changes: 18 additions & 0 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,24 @@ Testing

test

.. currentmodule:: pandas.plotting

Plotting
--------
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 move this section more to the bottom? There is already a small section on plotting that includes (de)register_matplotlib_converters, so you can merge both

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jorisvandenbossche Sure thing! Thanks for the feedback. Would it matter if I just did this in a new branch? I'm having trouble crafting the right git command that will un-commit and unstage my changes. Or is it preferred I keep everything on this branch? Or should I just put it in master?

Copy link
Member

Choose a reason for hiding this comment

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

Normally you should be able to do git rm doc/source/savefig/* and commit those changes. No need to un-commit the previous one (we will squash all commits into one in the end anyway).

Copy link
Member

Choose a reason for hiding this comment

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

So if that works, we would prefer that you further push to this branch / PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it. I'll do that now.


Miscellaneous
~~~~~~~~~~~~~

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 add a small sentence saying that those functions are contained in the pandas.plotting module?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll add this too.

.. autosummary::
:toctree: generated/

andrews_curves
bootstrap_plot
lag_plot
parallel_coordinates
radviz
scatter_matrix

.. _api.series:

Series
Expand Down
Binary file added doc/source/savefig/andrews_curve_winter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/andrews_curves.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/area_plot_stacked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/area_plot_unstacked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/autocorrelation_plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/bar_plot_ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/bar_plot_multi_ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/bar_plot_stacked_ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/barh_plot_stacked_ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/basics_assign.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/bollinger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/bootstrap_plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_new_colorize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_new_kwargs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_plot_ex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_plot_ex2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_plot_ex3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/box_plot_new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/boxplot_groupby.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/compare_interpolations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/cubehelix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/cubehelix_cm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/df_pie_plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/df_plot_xy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/errorbar_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/savefig/ewma_ex.png
Binary file added doc/source/savefig/expanding_mean_frame.png
Binary file added doc/source/savefig/frame_hist_ex.png
Binary file added doc/source/savefig/frame_plot_basic.png
Binary file added doc/source/savefig/frame_plot_basic_noleg.png
Binary file added doc/source/savefig/frame_plot_secondary_y.png
Binary file added doc/source/savefig/frame_plot_subplots.png
Binary file added doc/source/savefig/frame_plot_subplots_layout.png
Binary file added doc/source/savefig/greens.png
Binary file added doc/source/savefig/groupby_boxplot.png
Binary file added doc/source/savefig/groupby_boxplot_vis.png
Binary file added doc/source/savefig/groupby_transform_plot.png
Binary file added doc/source/savefig/grouped_hist.png
Binary file added doc/source/savefig/hexbin_plot.png
Binary file added doc/source/savefig/hexbin_plot_agg.png
Binary file added doc/source/savefig/hist_new.png
Binary file added doc/source/savefig/hist_new_kwargs.png
Binary file added doc/source/savefig/hist_new_stacked.png
Binary file added doc/source/savefig/hist_plot_ex.png
Binary file added doc/source/savefig/kde_plot.png
Binary file added doc/source/savefig/lag_plot.png
Binary file added doc/source/savefig/line_plot_table_data.png
Binary file added doc/source/savefig/line_plot_table_describe.png
Binary file added doc/source/savefig/line_plot_table_true.png
Binary file added doc/source/savefig/merge_on_index_and_column.png
Binary file added doc/source/savefig/merging_append1.png
Binary file added doc/source/savefig/merging_append2.png
Binary file added doc/source/savefig/merging_append3.png
Binary file added doc/source/savefig/merging_append_dits.png
Binary file added doc/source/savefig/merging_combine_first.png
Binary file added doc/source/savefig/merging_concat_axis1.png
Binary file added doc/source/savefig/merging_concat_axis1_inner.png
Binary file added doc/source/savefig/merging_concat_basic.png
Binary file added doc/source/savefig/merging_concat_dict.png
Binary file added doc/source/savefig/merging_concat_dict_keys.png
Binary file added doc/source/savefig/merging_concat_group_keys2.png
Binary file added doc/source/savefig/merging_concat_keys.png
Binary file added doc/source/savefig/merging_concat_mixed_ndim.png
Binary file added doc/source/savefig/merging_join.png
Binary file added doc/source/savefig/merging_join_inner.png
Binary file added doc/source/savefig/merging_join_key_columns.png
Binary file added doc/source/savefig/merging_join_multi_df.png
Binary file added doc/source/savefig/merging_join_multikeys.png
Binary file added doc/source/savefig/merging_join_outer.png
Binary file added doc/source/savefig/merging_merge_index_inner.png
Binary file added doc/source/savefig/merging_merge_index_outer.png
Binary file added doc/source/savefig/merging_merge_key_columns.png
Binary file added doc/source/savefig/merging_merge_on_key.png
Binary file added doc/source/savefig/merging_merge_on_key_dup.png
Binary file added doc/source/savefig/merging_merge_on_key_inner.png
Binary file added doc/source/savefig/merging_merge_on_key_left.png
Binary file added doc/source/savefig/merging_merge_on_key_outer.png
Binary file added doc/source/savefig/merging_merge_on_key_right.png
Binary file added doc/source/savefig/merging_merge_overlapped.png
Binary file added doc/source/savefig/merging_update.png
Binary file added doc/source/savefig/parallel_coordinates.png
Binary file added doc/source/savefig/parallel_gist_rainbow.png
Binary file added doc/source/savefig/quartile_boxplot.png
Binary file added doc/source/savefig/radviz.png
Binary file added doc/source/savefig/rolling_apply_ex.png
Binary file added doc/source/savefig/rolling_corr_pairwise_ex.png
Binary file added doc/source/savefig/rolling_mean_ex.png
Binary file added doc/source/savefig/rolling_mean_frame.png
Binary file added doc/source/savefig/scatter_matrix_kde.png
Binary file added doc/source/savefig/scatter_plot.png
Binary file added doc/source/savefig/scatter_plot_bubble.png
Binary file added doc/source/savefig/scatter_plot_colored.png
Binary file added doc/source/savefig/scatter_plot_repeated.png
Binary file added doc/source/savefig/ser_plot_suppress.png
Binary file added doc/source/savefig/ser_plot_suppress_context.png
Binary file added doc/source/savefig/ser_plot_suppress_parm.png
Binary file added doc/source/savefig/series_interpolate.png
Binary file added doc/source/savefig/series_pie_plot.png
Binary file added doc/source/savefig/series_pie_plot_options.png
Binary file added doc/source/savefig/series_pie_plot_semi.png
Binary file added doc/source/savefig/series_plot_basic.png
Binary file added doc/source/savefig/series_plot_basic2.png
Binary file added doc/source/savefig/series_plot_logy.png
Binary file added doc/source/savefig/series_plot_multi.png
Binary file added doc/source/savefig/series_plot_secondary_y.png
1 change: 1 addition & 0 deletions doc/test.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"schema": {"fields":[{"name":"index","type":"integer"},{"name":"bar","type":"string"},{"name":"baz","type":"datetime"},{"name":"foo","type":"integer"},{"name":"qux","type":"any","constraints":{"enum":["a","b","c"]},"ordered":false}],"primaryKey":["index"],"pandas_version":"0.20.0"}, "data": [{"index":0,"bar":"a","baz":"2018-01-01T00:00:00.000Z","foo":1,"qux":"a"},{"index":1,"bar":"b","baz":"2018-01-02T00:00:00.000Z","foo":2,"qux":"b"},{"index":2,"bar":"c","baz":"2018-01-03T00:00:00.000Z","foo":3,"qux":"c"},{"index":3,"bar":"d","baz":"2018-01-04T00:00:00.000Z","foo":4,"qux":"c"}]}