Refactor/python docstrings for base - Githubissues

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 base #196

Closed Dioprz closed 2 weeks ago

Dioprz commented 1 month ago

Description

Implementation of https://github.com/Crypto-TII/CryptographicEstimators/pull/169 for the base files at the root of the library.

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.

Cumulative test (with all the already migrated docstrings)

make docker-pytest-doctests

Note: You can comment the non-related directories in the Makefile for a faster run.

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
2 New issues
0 Accepted issues

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

See analysis details on SonarCloud