Closed Dioprz closed 3 weeks ago
Look at how are generated the docstrings now:
Test with make docker-doc
All the required changes for this were added at https://github.com/Crypto-TII/CryptographicEstimators/pull/191/commits/932828b87e3e2f6ec3fc26733590573bae9b02a3.
Basically I made two changes:
**kwargs
parameter, as I used this pattern in all the new docstrings-related PRs (IIRC). Now they look pretty much the same as in the docstrings: def __init__(self, n: int, k: int, w: int, memory_bound=inf, **kwargs):
"""Construct an instance of RegSDEstimator.
Args:
n (int): Code length.
k (int): Code dimension.
w (int): Error weight.
memory_bound: Memory bound.
**kwargs: Additional keyword arguments.
excluded_algorithms: A list/tuple of excluded algorithms (default: None).
nsolutions: No. of solutions.
"""
If you prefer to have this changes in another PR, let me know.
Help required
As you can see, I put the kwargs_formatter.py
directly in the root of the project. I don't know if you prefer to create another directory, or put it directly into the scripts/
or docs/
directory so... Just tell me where you want it and I will apply the change. @FloydZ @Javierverbel
From:
**kwargs --
Additional keyword arguments.
To
**kwargs -- Additional keyword arguments.
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code
yes.
Description
Implementation of https://github.com/Crypto-TII/CryptographicEstimators/pull/169 for RegSDEstimator.
Review process
Estimator-specific doctests
Cumulative test (with all the already migrated docstrings)
Pre-approval checklist