Skip to content

DOC: document subclasses in API docs with selection of specific methods/attributes #18202

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 34 commits into from
Nov 15, 2017
Merged

DOC: document subclasses in API docs with selection of specific methods/attributes #18202

Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
500ab71
DOC: Remove numpydoc hack, list methods explicitly
TomAugspurger Nov 9, 2017
257fc8a
[WIP]: API doc
TomAugspurger Nov 9, 2017
d59c0b5
More explicit methods
TomAugspurger Nov 10, 2017
cb57504
More updates
TomAugspurger Nov 10, 2017
5e4cf6d
typos
TomAugspurger Nov 10, 2017
346a73b
Merge remote-tracking branch 'upstream/master' into api-doc-methods
TomAugspurger Nov 11, 2017
b5902ff
more
TomAugspurger Nov 12, 2017
af1e866
Merge remote-tracking branch 'upstream/master' into api-doc-methods
TomAugspurger Nov 12, 2017
874aefe
Add accessors to hidden
TomAugspurger Nov 12, 2017
32c2816
Remove dupe section
TomAugspurger Nov 12, 2017
38673bd
Added Categorical
TomAugspurger Nov 12, 2017
e30335e
More fixups
TomAugspurger Nov 13, 2017
38efdcb
More cleanups
TomAugspurger Nov 13, 2017
5e8bcbe
PEP8
TomAugspurger Nov 13, 2017
8695727
Hide more items
TomAugspurger Nov 13, 2017
4476a5f
Fixups
TomAugspurger Nov 13, 2017
a5005e1
Matching NaT
TomAugspurger Nov 13, 2017
aa92592
Fix typo
TomAugspurger Nov 13, 2017
8841035
Merge remote-tracking branch 'upstream/master' into api-doc-methods
TomAugspurger Nov 13, 2017
1527cdb
PEP8
TomAugspurger Nov 13, 2017
7ca3434
Fix ordering, escaping
TomAugspurger Nov 14, 2017
5a0e10e
Add notes on contributing
TomAugspurger Nov 14, 2017
c8504d1
Fix kwds again
TomAugspurger Nov 14, 2017
f7ed015
Wording
TomAugspurger Nov 14, 2017
094f6f6
Fix ref
TomAugspurger Nov 14, 2017
1c2160f
Another fixup
TomAugspurger Nov 14, 2017
6e99be2
Series of dtype category
TomAugspurger Nov 14, 2017
3bd03db
Move more methods to hidden
TomAugspurger Nov 14, 2017
ba257cc
Hide get_loc
TomAugspurger Nov 14, 2017
169e833
Merge remote-tracking branch 'upstream/master' into api-doc-methods
TomAugspurger Nov 14, 2017
f846713
Just hide attributes
TomAugspurger Nov 14, 2017
141107a
Cleanup hidden
TomAugspurger Nov 14, 2017
3a224be
remove some methods from api.rst
jorisvandenbossche Nov 15, 2017
34834fa
fix warning for float64index
jorisvandenbossche Nov 15, 2017
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
Prev Previous commit
Next Next commit
Another fixup
  • Loading branch information
@TomAugspurger
TomAugspurger committed Nov 14, 2017
commit 1c2160f7c6e295b95f2bf03e914ca815e282ff40
46 changes: 23 additions & 23 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1859,7 +1859,7 @@ def _plot(data, x=None, y=None, subplots=False,
mark_right : boolean, default True
When using a secondary_y axis, automatically mark the column
labels with "(right)" in the legend
`**kwds` : keywords
`**kwds` : keywords
Options to pass to matplotlib plotting method

Returns
Expand Down Expand Up @@ -1955,7 +1955,7 @@ def plot_series(data, kind='line', ax=None, # Series unique
array of axes is returned with the same shape as ``layout``.
See the prose documentation for more.

`**kwds` : : Keyword Arguments
`**kwds` : Keyword Arguments
All other plotting keyword arguments to be passed to
matplotlib's boxplot function

Expand Down Expand Up @@ -2153,7 +2153,7 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None,
Tuple of (rows, columns) for the layout of the histograms
bins : integer, default 10
Number of histogram bins to be used
`**kwds` : other plotting keyword arguments
`**kwds` : other plotting keyword arguments
To be passed to hist function
"""
_setup()
Expand Down Expand Up @@ -2216,7 +2216,7 @@ def hist_series(self, by=None, ax=None, grid=True, xlabelsize=None,
figure size in inches by default
bins: integer, default 10
Number of histogram bins to be used
`**kwds` : keywords
`**kwds` : keywords
To be passed to the actual plotting function

Notes
Expand Down Expand Up @@ -2328,7 +2328,7 @@ def boxplot_frame_groupby(grouped, subplots=True, column=None, fontsize=None,
figsize : A tuple (width, height) in inches
layout : tuple (optional)
(rows, columns) for the layout of the plot
`**kwds` : : Keyword Arguments
`**kwds` : Keyword Arguments
All other plotting keyword arguments to be passed to
matplotlib's boxplot function

Expand Down Expand Up @@ -2507,7 +2507,7 @@ def line(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2522,7 +2522,7 @@ def bar(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2537,7 +2537,7 @@ def barh(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2552,7 +2552,7 @@ def box(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2569,7 +2569,7 @@ def hist(self, bins=10, **kwds):
----------
bins: integer, default 10
Number of histogram bins to be used
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2584,7 +2584,7 @@ def kde(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2601,7 +2601,7 @@ def area(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand All @@ -2616,7 +2616,7 @@ def pie(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.Series.plot`.

Returns
Expand Down Expand Up @@ -2667,7 +2667,7 @@ def line(self, x=None, y=None, **kwds):
----------
x, y : label or position, optional
Coordinates for each point.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2684,7 +2684,7 @@ def bar(self, x=None, y=None, **kwds):
----------
x, y : label or position, optional
Coordinates for each point.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2701,7 +2701,7 @@ def barh(self, x=None, y=None, **kwds):
----------
x, y : label or position, optional
Coordinates for each point.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2718,7 +2718,7 @@ def box(self, by=None, **kwds):
----------
by : string or sequence
Column in the DataFrame to group by.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2737,7 +2737,7 @@ def hist(self, by=None, bins=10, **kwds):
Column in the DataFrame to group by.
bins: integer, default 10
Number of histogram bins to be used
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2752,7 +2752,7 @@ def kde(self, **kwds):

Parameters
----------
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2771,7 +2771,7 @@ def area(self, x=None, y=None, **kwds):
----------
x, y : label or position, optional
Coordinates for each point.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2788,7 +2788,7 @@ def pie(self, y=None, **kwds):
----------
y : label or position, optional
Column to plot.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2809,7 +2809,7 @@ def scatter(self, x, y, s=None, c=None, **kwds):
Size of each point.
c : label or position, optional
Color of each point.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand All @@ -2834,7 +2834,7 @@ def hexbin(self, x, y, C=None, reduce_C_function=None, gridsize=None,
a single number (e.g. `mean`, `max`, `sum`, `std`).
gridsize : int, optional
Number of bins.
`**kwds` : optional
`**kwds` : optional
Keyword arguments to pass on to :py:meth:`pandas.DataFrame.plot`.

Returns
Expand Down