tslearn-team / tslearn-team/tslearn
Cross-correlation functions are undocumented
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.2k
- Forks
- 384
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 11
Description
Just noticed with the new v0.5 release that the cycc module has been moved along with all the other metrics, but none of the functions within the cycc module are documented: https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.metrics.html
I can do a PR. Do docstrings work in the same way for cython functions?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue identifies the cycc module and the tslearn.metrics documentation page; start by locating cycc and checking how its Cython functions expose docstrings to generated documentation. Done means the cross-correlation functions are included in the metrics documentation with visible descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100