Description
Several metric modules expose public functions without docstrings. This makes it difficult for new contributors to understand:
- what the function computes
- what parameters it expects
- what structure the function returns
Adding clear docstrings would improve maintainability and make the codebase easier to navigate for contributors.
Affected modules
The following modules contain public functions without docstrings:
structured_data_metrics/completeness.py
structured_data_metrics/duplicity.py
structured_data_metrics/outliers.py
structured_data_metrics/statistical_rate.py
structured_data_metrics/representation_rate.py
structured_data_metrics/add_noise.py
structured_data_metrics/summary_statistics.py
Expected fix
Add docstrings to the public functions in these modules following the format described in contributing.rst.
Example format:
def my_metric(data: pd.DataFrame, ...) -> dict:
"""
One-line summary.
Parameters
----------
data : pd.DataFrame
The input dataset.
...
Returns
-------
dict
Description of the returned structure.
"""
Docstrings should clearly explain:
- the purpose of the metric
- expected input parameters
- the structure of the returned result
Contribution scope
A contributor can choose one or multiple modules, as each module represents a self-contained task.
Skills needed
- Reading Python code
- Technical writing
No machine learning or AI expertise is required.
Description
Several metric modules expose public functions without docstrings. This makes it difficult for new contributors to understand:
Adding clear docstrings would improve maintainability and make the codebase easier to navigate for contributors.
Affected modules
The following modules contain public functions without docstrings:
structured_data_metrics/completeness.pystructured_data_metrics/duplicity.pystructured_data_metrics/outliers.pystructured_data_metrics/statistical_rate.pystructured_data_metrics/representation_rate.pystructured_data_metrics/add_noise.pystructured_data_metrics/summary_statistics.pyExpected fix
Add docstrings to the public functions in these modules following the format described in
contributing.rst.Example format:
Docstrings should clearly explain:
Contribution scope
A contributor can choose one or multiple modules, as each module represents a self-contained task.
Skills needed
No machine learning or AI expertise is required.