feat(repr): Give a description to attributes

[MarieSacksick]

Closes #1235

I had to go through regex because from what I understand from inspect, there is no way to access the documentation of an attribute. There is very little risk that the regex matches something before the attribute description because of naming overlap. If we think that this risk is to big, as there is no way to do a test, we should close #1235 as not possible.

What it does for an EstimatorReport:

What it does for a CrossValidationReport:

What it does for a ComparisonReport:

[github-actions]

Coverage Report for backend

File	Stmts	Miss	Cover	Missing
venv/lib/python3.12/site-packages/skore
__init__.py	15	0	100%
_config.py	28	0	100%
exceptions.py	4	4	0%	4–23
venv/lib/python3.12/site-packages/skore/persistence
__init__.py	0	0	100%
venv/lib/python3.12/site-packages/skore/persistence/item
__init__.py	55	1	98%	97
altair_chart_item.py	19	1	91%	14
item.py	22	1	95%	86
matplotlib_figure_item.py	36	1	95%	19
media_item.py	22	0	100%
numpy_array_item.py	27	1	94%	16
pandas_dataframe_item.py	29	1	94%	14
pandas_series_item.py	29	1	94%	14
pickle_item.py	22	0	100%
pillow_image_item.py	25	1	93%	15
plotly_figure_item.py	20	1	92%	14
polars_dataframe_item.py	27	1	94%	14
polars_series_item.py	22	1	92%	14
primitive_item.py	23	2	91%	13–15
sklearn_base_estimator_item.py	29	1	94%	15
venv/lib/python3.12/site-packages/skore/persistence/repository
__init__.py	2	0	100%
item_repository.py	59	5	91%	15–16, 202–203, 226
venv/lib/python3.12/site-packages/skore/persistence/storage
__init__.py	4	0	100%
abstract_storage.py	22	0	100%
disk_cache_storage.py	33	1	95%	44
in_memory_storage.py	20	0	100%
venv/lib/python3.12/site-packages/skore/project
__init__.py	2	0	100%
project.py	81	1	99%	283
venv/lib/python3.12/site-packages/skore/sklearn
__init__.py	6	0	100%
_base.py	170	14	92%	44, 57, 125, 128, 181–190, 202–>208, 223, 226–227
find_ml_task.py	61	0	99%	136–>144
types.py	13	2	85%	33, 61
venv/lib/python3.12/site-packages/skore/sklearn/_comparison
__init__.py	5	0	100%
metrics_accessor.py	164	2	97%	165, 166–>168, 1218
precision_recall_curve_display.py	73	1	97%	196–>199, 304
prediction_error_display.py	67	10	78%	97, 154–>exit, 209, 214–218, 227, 231, 236–238
report.py	64	1	96%	16, 251–>254
roc_curve_display.py	69	1	96%	204–>213, 213–>216, 308
venv/lib/python3.12/site-packages/skore/sklearn/_cross_validation
__init__.py	5	0	100%
metrics_accessor.py	170	0	99%	142–>144, 144–>146
report.py	105	1	98%	22
venv/lib/python3.12/site-packages/skore/sklearn/_estimator
__init__.py	7	0	100%
feature_importance_accessor.py	39	0	100%
metrics_accessor.py	325	11	95%	166–175, 203–>212, 211, 241, 252–>254, 282, 309–313, 328, 351, 363, 364–>366
report.py	127	1	97%	22, 229–>235, 237–>239
venv/lib/python3.12/site-packages/skore/sklearn/_plot
__init__.py	4	0	100%
precision_recall_curve.py	129	1	98%	240–>257, 329
prediction_error.py	102	1	98%	173, 189–>192
roc_curve.py	143	0	100%
style.py	14	0	100%
utils.py	99	5	94%	31, 55–57, 61
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split
__init__.py	0	0	100%
train_test_split.py	36	2	94%	16–17
venv/lib/python3.12/site-packages/skore/sklearn/train_test_split/warning
__init__.py	8	0	100%
high_class_imbalance_too_few_examples_warning.py	17	1	90%	79
high_class_imbalance_warning.py	18	0	100%
random_state_unset_warning.py	12	1	88%	15
shuffle_true_warning.py	10	1	83%	46
stratify_is_set_warning.py	12	1	88%	15
time_based_column_warning.py	23	2	86%	17, 73
train_test_split_warning.py	5	1	80%	21
venv/lib/python3.12/site-packages/skore/utils
__init__.py	6	0	100%
_accessor.py	17	0	100%
_environment.py	27	27	0%	1–51
_index.py	5	0	100%
_logger.py	22	22	0%	3–38
_parallel.py	38	3	88%	23–33, 124
_patch.py	13	5	53%	21–37
_progress_bar.py	34	0	100%
_show_versions.py	33	2	95%	65–66
TOTAL	2974	144	94%

Tests	Skipped	Failures	Errors	Time
635	3 💤	0 ❌	0 🔥	54.161s ⏱️

[github-actions]

Documentation preview @ b198cdb

[auguste-probabl]

Works for me in principle!

[glemaitre]

I would request a test in the different reporter to at least on one attribute just to catch potential regression in the future.

[auguste-probabl]

Thanks