Skip to content

Commit

Permalink
Fix docstrings (#3678)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaozGelbart authored Apr 25, 2024
1 parent d767578 commit f0b48e8
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
15 changes: 11 additions & 4 deletions seaborn/categorical.py
Original file line number Diff line number Diff line change
Expand Up @@ -1838,7 +1838,7 @@ def violinplot(
the data within each group.
.. versionadded:: v0.13.0
bw_adjust: float
bw_adjust : float
Factor that scales the bandwidth to use more or less smoothing.
.. versionadded:: v0.13.0
Expand Down Expand Up @@ -2028,17 +2028,17 @@ def boxenplot(
{native_scale}
{formatter}
{legend}
box_kws: dict
box_kws : dict
Keyword arguments for the box artists; passed to
:class:`matplotlib.patches.Rectangle`.
.. versionadded:: v0.12.0
line_kws: dict
line_kws : dict
Keyword arguments for the line denoting the median; passed to
:meth:`matplotlib.axes.Axes.plot`.
.. versionadded:: v0.12.0
flier_kws: dict
flier_kws : dict
Keyword arguments for the scatter denoting the outlier observations;
passed to :meth:`matplotlib.axes.Axes.scatter`.
Expand Down Expand Up @@ -2295,10 +2295,13 @@ def swarmplot(
brightness is determined by the color palette used for the body
of the points.
{linewidth}
{hue_norm}
{log_scale}
{native_scale}
{formatter}
{legend}
warn_thresh : float
The proportion of points that must overlap to trigger a warning.
{ax_in}
kwargs : key, value mappings
Other keyword arguments are passed through to
Expand Down Expand Up @@ -2556,6 +2559,7 @@ def pointplot(
{stat_api_params}
{color}
{palette}
{hue_norm}
markers : string or list of strings
Markers to use for each of the `hue` levels.
linestyles : string or list of strings
Expand Down Expand Up @@ -2711,6 +2715,7 @@ def countplot(
{color}
{palette}
{saturation}
{fill}
{hue_norm}
stat : {{'count', 'percent', 'proportion', 'probability'}}
Statistic to compute; when not `'count'`, bar heights will be normalized so that
Expand All @@ -2719,6 +2724,7 @@ def countplot(
.. versionadded:: v0.13.0
{width}
{dodge}
{gap}
{log_scale}
{native_scale}
{formatter}
Expand Down Expand Up @@ -3185,6 +3191,7 @@ def catplot(
{col_wrap}
{height}
{aspect}
{log_scale}
{native_scale}
{formatter}
{orient}
Expand Down
12 changes: 11 additions & 1 deletion seaborn/regression.py
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,10 @@ def lineplot(self, ax, kws):
If ``True``, the regression line is bounded by the data limits. If
``False``, it extends to the ``x`` axis limits.
"""),
dropna=dedent("""\
dropna : bool, optional
If ``True``, remove observations with missing data from the plot.
"""),
xy_jitter=dedent("""\
{x,y}_jitter : floats, optional
Add uniform random noise of this size to either the ``x`` or ``y``
Expand Down Expand Up @@ -729,6 +733,11 @@ def update_datalim(data, x, y, ax, **kws):
facet_kws : dict
Dictionary of keyword arguments for :class:`FacetGrid`.
Returns
-------
:class:`FacetGrid`
The :class:`FacetGrid` object with the plot on it for further tweaking.
See Also
--------
regplot : Plot data and a conditional model fit.
Expand Down Expand Up @@ -783,7 +792,7 @@ def regplot(
Parameters
----------
x, y: string, series, or vector array
x, y : string, series, or vector array
Input variables. If strings, these should correspond with column names
in ``data``. When pandas objects are used, axes will be labeled with
the series name.
Expand All @@ -804,6 +813,7 @@ def regplot(
{logx}
{xy_partial}
{truncate}
{dropna}
{xy_jitter}
label : string
Label to apply to either the scatterplot or regression line (if
Expand Down

0 comments on commit f0b48e8

Please sign in to comment.