From 61a1b024602f424c47da39f788e4f0e30570d4fd Mon Sep 17 00:00:00 2001 From: Pierre-antoine Comby Date: Tue, 26 Apr 2022 15:42:37 +0200 Subject: [PATCH 1/2] [lint] pydocstyle compliance. --- modopt/opt/linear.py | 1 - modopt/opt/proximity.py | 2 +- setup.cfg | 5 +++++ 3 files changed, 6 insertions(+), 2 deletions(-) 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..06a7a372 100644 --- a/setup.cfg +++ b/setup.cfg @@ -89,3 +89,8 @@ addopts = --cov-report=term --cov-report=xml --junitxml=pytest.xml + +[pydocstyle] +convention=numpy +match_dir= ^(?!(docs|\.)).* +match= (?!(test_|setup)).*\.py From a7fc4d3fc90bdf9b4f70d39094649b6f7d94b2e4 Mon Sep 17 00:00:00 2001 From: Pierre-antoine Comby Date: Mon, 2 May 2022 13:57:03 +0200 Subject: [PATCH 2/2] use pytest-pydocstyle --- develop.txt | 1 + setup.cfg | 3 +-- 2 files changed, 2 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/setup.cfg b/setup.cfg index 06a7a372..87496ced 100644 --- a/setup.cfg +++ b/setup.cfg @@ -89,8 +89,7 @@ addopts = --cov-report=term --cov-report=xml --junitxml=pytest.xml + --pydocstyle [pydocstyle] convention=numpy -match_dir= ^(?!(docs|\.)).* -match= (?!(test_|setup)).*\.py