Skip to content
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.

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

Add flake8-docstrings #301

Merged
merged 12 commits into from
Nov 23, 2021
Merged

Add flake8-docstrings #301

merged 12 commits into from
Nov 23, 2021

Conversation

fealho
Copy link
Member

@fealho fealho commented Nov 10, 2021

As part of #278, added flake8-docstrings addon and adapted our code to follow this style check.

@codecov-commenter
Copy link

codecov-commenter commented Nov 10, 2021

Codecov Report

Merging #301 (c7b5de4) into issue-278-base (4771669) will decrease coverage by 0.00%.
The diff coverage is 0.00%.

Impacted file tree graph

@@                Coverage Diff                 @@
##           issue-278-base     #301      +/-   ##
==================================================
- Coverage           87.25%   87.24%   -0.01%     
==================================================
  Files                  27       27              
  Lines                1702     1701       -1     
==================================================
- Hits                 1485     1484       -1     
  Misses                217      217              
Impacted Files Coverage Δ
copulas/__init__.py 97.70% <ø> (-0.03%) ⬇️
copulas/bivariate/__init__.py 96.96% <ø> (ø)
copulas/bivariate/base.py 86.89% <ø> (ø)
copulas/bivariate/clayton.py 84.78% <ø> (ø)
copulas/bivariate/frank.py 90.74% <ø> (ø)
copulas/bivariate/gumbel.py 87.75% <ø> (ø)
copulas/bivariate/independence.py 68.42% <ø> (ø)
copulas/bivariate/utils.py 80.00% <ø> (ø)
copulas/datasets.py 50.00% <ø> (ø)
copulas/multivariate/__init__.py 100.00% <ø> (ø)
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4771669...c7b5de4. Read the comment docs.

@fealho fealho marked this pull request as ready for review November 19, 2021 15:47
@fealho fealho requested a review from a team as a code owner November 19, 2021 15:47
@fealho fealho requested review from amontanez24, csala and a team and removed request for a team November 19, 2021 15:47
Copy link
Contributor

@csala csala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Collaborator

@amontanez24 amontanez24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of small typos to fix, but after that it should be good to go!

"""Context manager for managing the random seed.

Args:
seed(int):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: is there supposed to be a space in between?

@@ -30,15 +31,16 @@ def compare_nested_dicts(first, second, epsilon=10E-6):


def compare_values_epsilon(first, second, epsilon=10E-6,):
"""Comprae epsilons."""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: typo Compare

@fealho fealho merged commit af83377 into issue-278-base Nov 23, 2021
@fealho fealho deleted the issue-278-docstrings branch November 23, 2021 01:27
fealho added a commit that referenced this pull request Nov 24, 2021
* Add working libraries

* Add addon

* Remove pydocstyle

* Fix unrelated error

* Make double quotes into single (#289)

* Add `flake8-eradicate` (#293)

* Add addon

* Remove paranthesis because the addon thinks they are code

* Add addon

* Remove paranthesis because the addon thinks they are code

* Add `flake8-builtins` (#296)

* Add addon

* Update code according to addon

* Add addon

* Update code according to addon

* Add `pandas-vet` (#299)

* Add addon

* Update code according to addon

* Add addon

* Update code according to addon

* Add absolute import

* Add sfs (#305)

* Add `flake8-multiline-containers` (#290)

* Not sure what to do about these

* Add noqa's where necessary

* Not sure what to do about these

* Add noqa's where necessary

* Address feedback

* Add `flake8-expression-complexity` (#291)

* Add addon

* Change the complexity limit to 8 from 7

* Add addon

* Change the complexity limit to 8 from 7

* Fix complexity

* Rename + remove unnecessary argsort

* Add `flake8-print` (#292)

* Add addon

* Address feedback

* Add `flake8-comprehensions` (#295)

* Add addon

* Fix code according to addon

* Add addon

* Fix code according to addon

* Fix errors

* Fix set as literal

* Address feedback

* Add `pytest-style` (#297)

* Add addon

* Update code according to addon

* Add addon

* Update code according to addon

* Fix errors

* Delete pytest

* Address feedback

* Add `flake8-docstrings` (#301)

* Add addon

* Update code according to addon

* Add addon

* Update code according to addon

* Update code according to pydocstyle

* Fixes

* Fix errors

* Update docstrings

* Fix typos

* Add addon and ignore erros (#304)

* Add `flake8-dlint` (#300)

* Add addon

* Ignore error

* Add addon

* Ignore error

* Add `pep8-naming` (#298)

* Add addon

* Ignore all the variable names

* Add addon

* Ignore all the variable names

* Move ignores to setup.cfg

* Add `flake8-fixme` (#294)

* Add addon

* Remove fixme

* Add addon

* Remove fixme

* Fix bug

* Fix details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants