From ad4c496f94793b3a872f96502cefcf0a1c396cfa Mon Sep 17 00:00:00 2001
From: Pierre-Antoine Comby <77174042+paquiteau@users.noreply.github.com>
Date: Mon, 2 May 2022 15:12:39 +0200
Subject: [PATCH] [lint] pydocstyle compliance. (#228)

* [lint] pydocstyle compliance.

* use pytest-pydocstyle
---
 develop.txt             | 1 +
 modopt/opt/linear.py    | 1 -
 modopt/opt/proximity.py | 2 +-
 setup.cfg               | 4 ++++
 4 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/develop.txt b/develop.txt
index 8beef0ff..7397e15c 100644
--- a/develop.txt
+++ b/develop.txt
@@ -7,3 +7,4 @@ pytest-pep8>=1.0.6
 pytest-emoji>=0.2.0
 pytest-flake8>=1.0.7
 wemake-python-styleguide>=0.15.2
+pytest-pydocstyle>=2.2.0
diff --git a/modopt/opt/linear.py b/modopt/opt/linear.py
index d8679998..3807253b 100644
--- a/modopt/opt/linear.py
+++ b/modopt/opt/linear.py
@@ -150,7 +150,6 @@ class LinearCombo(LinearParent):
     See Also
     --------
     LinearParent : parent class
-
     """
 
     def __init__(self, operators, weights=None):
diff --git a/modopt/opt/proximity.py b/modopt/opt/proximity.py
index f8f368ef..e8492367 100644
--- a/modopt/opt/proximity.py
+++ b/modopt/opt/proximity.py
@@ -993,7 +993,7 @@ def _interpolate(self, alpha0, alpha1, sum0, sum1):
         :math:`\sum\theta(\alpha^*)=k` via a linear interpolation.
 
         Parameters
-        -----------
+        ----------
         alpha0: float
             A value for wich :math:`\sum\theta(\alpha^0) \leq k`
         alpha1: float
diff --git a/setup.cfg b/setup.cfg
index cabd35a0..87496ced 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -89,3 +89,7 @@ addopts =
   --cov-report=term
   --cov-report=xml
   --junitxml=pytest.xml
+  --pydocstyle
+
+[pydocstyle]
+convention=numpy