Refactor/python docstrings for mr estimator

Crypto-TII / CryptographicEstimators

This project gathers and standardize command line scripts to estimate the difficulty of solving hard mathematical problems related to cryptography.

https://estimators.crypto.tii.ae/

GNU General Public License v3.0

34 stars 5 forks source link

Refactor/python docstrings for mr estimator #185

Closed Dioprz closed 2 weeks ago

Dioprz commented 1 month ago

Description

Implementation of https://github.com/Crypto-TII/CryptographicEstimators/pull/169 for MREstimator.

Review process

A quick glance at the new docstrings would be great.

Estimator-specific doctests

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

Cumulative test (with all the already migrated docstrings)

make docker-pytest-doctests

Pre-approval checklist

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

sonarcloud[bot] commented 2 weeks ago

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

Javierverbel commented 2 weeks ago

Description

Implementation of #169 for MREstimator.

Review process

A quick glance at the new docstrings would be great.

Estimator-specific doctests
make docker-build
make docker-run
pytest --doctest-modules -n auto -vv cryptographic_estimators/MREstimator
Cumulative test (with all the already migrated docstrings)
make docker-doctests
or
make docker-doctests-fast
Pre-approval checklist

[x] The code builds clean without any errors or warnings

[x] I've added/updated tests

[x] I've added/updated documentation if needed