Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation is out of date #340

Open
kxygk opened this issue Aug 8, 2019 · 4 comments
Open

API documentation is out of date #340

kxygk opened this issue Aug 8, 2019 · 4 comments
Labels

Comments

@kxygk
Copy link

kxygk commented Aug 8, 2019

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
Copy link
Author

kxygk commented Aug 18, 2019

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 mikera added the bug label Aug 19, 2019
@mikera
Copy link
Owner

mikera commented Aug 19, 2019

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
Copy link

mars0i commented May 29, 2023

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
Copy link
Owner

mikera commented May 30, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants