search

holgerteichgraeber / TimeSeriesClustering.jl

Julia implementation of unsupervised learning methods for time series datasets. It provides functionality for clustering and aggregating, detecting motifs, and quantifying similarity between time series datasets.
MIT License
82 stars 23 forks source link

Documentation #49

Closed holgerteichgraeber closed 5 years ago

holgerteichgraeber commented 5 years ago

Created branch dev . Todos on master:

YoungFaithful commented 5 years ago

What do you think about using https://juliadocs.github.io/Documenter.jl/stable/man/guide/ ? I think it could be useful as all our well done comments with the functions would immediately be included.

holgerteichgraeber commented 5 years ago

Great idea, let's try it. I made a branch documentation, feel free to push to that branch. Will that automatically generate documentation for the functions we wrote?

YoungFaithful commented 5 years ago

I have difficulties installing your ClustForOpt_priv next to mine in julia. Are we in general planning to rename yours to ClustForOpt again?

holgerteichgraeber commented 5 years ago

Yes. If you prefer, we can do that now.

YoungFaithful commented 5 years ago

I think that would be easiest

holgerteichgraeber commented 5 years ago

Sounds good, let me look into it. You may have to change some remote references (and probably rename yours too) to make it work afterwards.

YoungFaithful commented 5 years ago

Yeah, makes sense

holgerteichgraeber commented 5 years ago

Rename done.

YoungFaithful commented 5 years ago

All our "inline" documentation has to look like this: ` """ func(x)

Returns double the number x plus 1. """ func(x) = 2x + 1`

holgerteichgraeber commented 5 years ago

While going through the examples and tests, I get an error that interstorage is not defined. I assume this slipped through somewhere in the past PRs, could you have a look @YoungFaithful ?

holgerteichgraeber commented 5 years ago

While going through the examples and tests, I get an error that interstorage is not defined. I assume this slipped through somewhere in the past PRs, could you have a look @YoungFaithful ?

Never mind, I think this was dealt with in PR #53 I'll test it

holgerteichgraeber commented 5 years ago

Great, tests passed after the PR. Thank you for updating.

holgerteichgraeber commented 5 years ago

@YoungFaithful I updated documentation and README, you can go ahead and update travis:

As soon as your done with the review and added your part we just need to follow the directions here: https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#Hosting-Documentation-1 to setup travis alternatively we could also just export it as pdf

Will this create a documentation that is part of this github repo?

holgerteichgraeber commented 5 years ago

Closed with #60