Listed metrics deviate between extraction functions in docs about textdescriptives HOT 7 CLOSED

It would be (but you could quite often miss a few places. This allows for mistakes while still allowing the user to figure out what the valid metrics are (It also allows user to add their own metrics).

Which metrics to extract. Could for example include one or more of [“descriptive_stats”, “readability”, “dependency_distance”, “pos_proportions”, “coherence”, “quality”]. To see the full list available metrics see td.get_valid_metrics(). If None, will extract all metrics from textdescriptives. Defaults to None.

from textdescriptives.

But we should def. just update the docstring to be the same.

from textdescriptives.

Perhaps we should refer to the textdescriptives.utils.get_valid_metrics function?

from textdescriptives.

You mean it's better to automate updating this than going through it manually every now and then when someone makes an issue?

Do you know how to generate parts of docstrings dynamically? I haven't tried that before.

from textdescriptives.

I think lasse means that we can update the docs from:

Which metrics to extract. One or more of [“descriptive_stats”, “readability”, “dependency_distance”, “pos_proportions”, “coherence”, “quality”]. If None, will extract all metrics from textdescriptives. Defaults to None.

to:

Which metrics to extract. Could for example include one or more of [“descriptive_stats”, “readability”, “dependency_distance”, “pos_proportions”, “coherence”, “quality”]. To see the full list available metrics see `td.get_valid_metrics()`. If None, will extract all metrics from textdescriptives. Defaults to None.

from textdescriptives.

The metrics are already all available in the get_valid_metrics and will be updated automatically when new components are added as the use the registries from spacy.

from textdescriptives.

How often do you add metrics? Shouldn't it be possible to manually update it? Search for one of the metrics in the repo and add it everywhere. But yes, having it as an extra (in case docs aren't updated, look here) thing, seems fine. Autogenerating that part of the docstring (if possible) also seems fine though.

from textdescriptives.