[DOC] Improve similarity search docstrings

aeon-toolkit / aeon

A toolkit for machine learning from time series

https://aeon-toolkit.org/

BSD 3-Clause "New" or "Revised" License

964 stars 112 forks source link

Open baraline opened 2 weeks ago

baraline commented 2 weeks ago

In some dosctring, the math environment is used, which can lead to some variables like query_length being not displayed correctly due to the underscore
Other docstrings, should also be reviewed as some are non-descriptive (e.g. predict function in Series Search)
Make sure similar parameters use the same docstrings through the whole module.

Replace math environments with double quote?

aryanpola commented 4 days ago

@baraline haven't found any docstring that raises issues like query_length in the math environment.