Skip to content

Commit f0b48e8

Browse files
authored
Fix docstrings (#3678)
1 parent d767578 commit f0b48e8

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

seaborn/categorical.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1838,7 +1838,7 @@ def violinplot(
18381838
the data within each group.
18391839
18401840
.. versionadded:: v0.13.0
1841-
bw_adjust: float
1841+
bw_adjust : float
18421842
Factor that scales the bandwidth to use more or less smoothing.
18431843
18441844
.. versionadded:: v0.13.0
@@ -2028,17 +2028,17 @@ def boxenplot(
20282028
{native_scale}
20292029
{formatter}
20302030
{legend}
2031-
box_kws: dict
2031+
box_kws : dict
20322032
Keyword arguments for the box artists; passed to
20332033
:class:`matplotlib.patches.Rectangle`.
20342034
20352035
.. versionadded:: v0.12.0
2036-
line_kws: dict
2036+
line_kws : dict
20372037
Keyword arguments for the line denoting the median; passed to
20382038
:meth:`matplotlib.axes.Axes.plot`.
20392039
20402040
.. versionadded:: v0.12.0
2041-
flier_kws: dict
2041+
flier_kws : dict
20422042
Keyword arguments for the scatter denoting the outlier observations;
20432043
passed to :meth:`matplotlib.axes.Axes.scatter`.
20442044
@@ -2295,10 +2295,13 @@ def swarmplot(
22952295
brightness is determined by the color palette used for the body
22962296
of the points.
22972297
{linewidth}
2298+
{hue_norm}
22982299
{log_scale}
22992300
{native_scale}
23002301
{formatter}
23012302
{legend}
2303+
warn_thresh : float
2304+
The proportion of points that must overlap to trigger a warning.
23022305
{ax_in}
23032306
kwargs : key, value mappings
23042307
Other keyword arguments are passed through to
@@ -2556,6 +2559,7 @@ def pointplot(
25562559
{stat_api_params}
25572560
{color}
25582561
{palette}
2562+
{hue_norm}
25592563
markers : string or list of strings
25602564
Markers to use for each of the `hue` levels.
25612565
linestyles : string or list of strings
@@ -2711,6 +2715,7 @@ def countplot(
27112715
{color}
27122716
{palette}
27132717
{saturation}
2718+
{fill}
27142719
{hue_norm}
27152720
stat : {{'count', 'percent', 'proportion', 'probability'}}
27162721
Statistic to compute; when not `'count'`, bar heights will be normalized so that
@@ -2719,6 +2724,7 @@ def countplot(
27192724
.. versionadded:: v0.13.0
27202725
{width}
27212726
{dodge}
2727+
{gap}
27222728
{log_scale}
27232729
{native_scale}
27242730
{formatter}
@@ -3185,6 +3191,7 @@ def catplot(
31853191
{col_wrap}
31863192
{height}
31873193
{aspect}
3194+
{log_scale}
31883195
{native_scale}
31893196
{formatter}
31903197
{orient}

seaborn/regression.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,10 @@ def lineplot(self, ax, kws):
557557
If ``True``, the regression line is bounded by the data limits. If
558558
``False``, it extends to the ``x`` axis limits.
559559
"""),
560+
dropna=dedent("""\
561+
dropna : bool, optional
562+
If ``True``, remove observations with missing data from the plot.
563+
"""),
560564
xy_jitter=dedent("""\
561565
{x,y}_jitter : floats, optional
562566
Add uniform random noise of this size to either the ``x`` or ``y``
@@ -729,6 +733,11 @@ def update_datalim(data, x, y, ax, **kws):
729733
facet_kws : dict
730734
Dictionary of keyword arguments for :class:`FacetGrid`.
731735
736+
Returns
737+
-------
738+
:class:`FacetGrid`
739+
The :class:`FacetGrid` object with the plot on it for further tweaking.
740+
732741
See Also
733742
--------
734743
regplot : Plot data and a conditional model fit.
@@ -783,7 +792,7 @@ def regplot(
783792
784793
Parameters
785794
----------
786-
x, y: string, series, or vector array
795+
x, y : string, series, or vector array
787796
Input variables. If strings, these should correspond with column names
788797
in ``data``. When pandas objects are used, axes will be labeled with
789798
the series name.
@@ -804,6 +813,7 @@ def regplot(
804813
{logx}
805814
{xy_partial}
806815
{truncate}
816+
{dropna}
807817
{xy_jitter}
808818
label : string
809819
Label to apply to either the scatterplot or regression line (if

0 commit comments

Comments
 (0)