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

sourmash documentation #901

Closed
phiweger opened this issue Feb 11, 2020 · 3 comments
Closed

sourmash documentation #901

phiweger opened this issue Feb 11, 2020 · 3 comments

Comments

@phiweger
Copy link

After some struggle and googling through the repo, I found this "internal" API documentation much better than the "official" one. It might be helpful to link it?

@phiweger
Copy link
Author

Can't believe I overlooked that, sorry.

@ctb
Copy link
Contributor

ctb commented Feb 11, 2020

hi @phiweger one problem is that the "official" API documentation isn't getting built properly. So that's something we're working on fixing. The official docs did get a bit of a potential upgrade in #889, but of course that's not reflected in the current docs because of the bug above.

In our actually fairly reasonable defense, the docs you eventually found are linked directly at the top of the not-so-useful ones .

@phiweger
Copy link
Author

that defence is very justified, I did realise there was a link like 0.5 seconds after posting the issue :)

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

No branches or pull requests

2 participants