fixed pydocstyle errors

arviz-devs · Jun 17, 2021 · 1a36bbd · 1a36bbd
1 parent c979d20
commit 1a36bbd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/arviz/plots/backends/matplotlib/lmplot.py b/arviz/plots/backends/matplotlib/lmplot.py
@@ -1,3 +1,4 @@
+"""Matplotlib plot linear regression figure."""
 import matplotlib.pyplot as plt
 import numpy as np
 
@@ -11,7 +12,7 @@ def plot_lm(
     y_ppc,
     num_ppc_samples,
 ):
-
+    """Matplotlib Linear Regression."""
     _, ax = plt.subplots(1, 1, figsize=(6, 4), dpi=100)
 
     # plot data

diff --git a/arviz/plots/lmplot.py b/arviz/plots/lmplot.py
@@ -1,3 +1,4 @@
+"""Plot linear regression figure."""
 from ..rcparams import rcParams
 from .plot_utils import get_plotting_function
 
@@ -15,7 +16,8 @@ def plot_lm(
     num_ppc_samples=100,
     backend=None,
 ):
-    """Plot lm
+    """Plot linear regression figure to visualize uncertaininty in mean and ppc values.
+
     Parameters
     ----------
     idata : az.InferenceData object
@@ -30,14 +32,9 @@ def plot_lm(
     num_ppc_samples : int
     backend : str, optional
         Select plotting backend {"matplotlib","bokeh"}. Default "matplotlib".
-    line_err : bool
-    y_err : bool
-    x_err : bool
-    xscale : str
-    yscale : str
 
     Returns
-    ------
+    -------
     axes
     """