search

mikera / core.matrix

core.matrix : Multi-dimensional array programming API for Clojure
Other
700 stars 113 forks source link

API documentation is out of date #340

Open kxygk opened 4 years ago

kxygk commented 4 years ago

The project is at version 0.62.0 but the API docs that are linked are labeled as version 0.44.0

Maybe there is a good reason.. but maybe there should be some warning? Especially since it's linked to from the main README

I just hit some warning about clojure.core.matrix/rank where I couldn't :require both clojure.core.matrix and clojure.core.matrix.linear (weird that you have namespaces clash in the same library)

I was very confused for a few minutes b/c I couldn't find clojure.core.matrix/rank in the API docs

kxygk commented 4 years ago

I see now that I'm supposed to be looking at this: https://cljdoc.org/d/net.mikera/core.matrix/0.62.0/api/clojure

I'm not sure why https://mikera.github.io/core.matrix/doc/index.html exists and is being linked to from the README

mikera commented 4 years ago

Hi @geokongh It was meant to be set up so that the documentation builds to the github.io site, but something seems to have broken. Will take a look when I get the chance.

mars0i commented 1 year ago

Since the docs are so out of date, would it be worthwhile to do rebuild them by hand at this point? That's not as good as an automatic rebuild procedure, obviously, but might be easier as a temporary fix.

mikera commented 1 year ago

If anyone has the time or inclination, we could maybe convert these to a github site / build script? Happy to merge PRs if ncessary