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.

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

Jump to bottom

Refactor/python docstrings for le estimator #193

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Refactor/python docstrings for le estimator #193

wants to merge 2 commits into from
+126 −176

Conversation

Dioprz
Copy link
Collaborator

@Dioprz Dioprz commented Sep 28, 2024

Description

Implementation of #169 for LEEstimator.

Review process

  • A quick glance at the new docstrings would be great.
  • Please search by FIX and TODO in the diff view, in case I has moved some previously existent comment.

Estimator-specific doctests

make docker-run
pytest --doctest-modules -n auto -vv cryptographic_estimators/LEEstimator

Cumulative test (with all the already migrated docstrings)

make docker-pytest-doctests

Pre-approval checklist

  • The code builds clean without any errors or warnings
  • I've added/updated tests
  • I've added/updated documentation if needed

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Sep 28, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
66.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Javierverbel Javierverbel Awaiting requested review from Javierverbel

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Dioprz