Skip to content

[lint] pydocstyle compliance. #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sfarrens merged 2 commits into from
May 2, 2022
Merged

[lint] pydocstyle compliance. #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61a1b02
[lint] pydocstyle compliance.
paquiteau Apr 26, 2022
a7fc4d3
use pytest-pydocstyle
paquiteau May 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions develop.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion modopt/opt/linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@ class LinearCombo(LinearParent):
See Also
--------
LinearParent : parent class

"""

def __init__(self, operators, weights=None):
Expand Down
2 changes: 1 addition & 1 deletion modopt/opt/proximity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,7 @@ addopts =
--cov-report=term
--cov-report=xml
--junitxml=pytest.xml
--pydocstyle

[pydocstyle]
convention=numpy