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

Bug: missing API documentation #95

Closed
4 tasks done
backspaces opened this issue Aug 1, 2017 · 5 comments
Closed
4 tasks done

Bug: missing API documentation #95

backspaces opened this issue Aug 1, 2017 · 5 comments
Labels
Bug Something isn't working. Documentation Improvements, additions, or changes to documentation. Website Issue concerning the project website.

Comments

@backspaces
Copy link

backspaces commented Aug 1, 2017

Checklist

Please ensure the following tasks are completed before filing an issue.

  • Read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • If this is a general question, searched the FAQ for an existing answer.
  • If this is a feature request, the issue name begins with RFC: .

Description

Description of the issue (or feature request).

I may be missing something, but after looking around, and using your Issues template, I couldn't find APIs for the wrappers over the C/Fortran libraries like LaPack etc.

Where are the API docs?

Related Issues

Does this issue (or feature request) have any related issues?

I couldn't tell.

Questions

Any questions for reviewers?

Have I missed something? Saw the video on youtube and wanted to try the project for linear algebra using LaPack or similar. Can't find API docs.

@Planeshifter
Copy link
Member

Thank you for your interest in stdlib. You were not able to find any API documentation because this part of the library is in its infancy and under active development. As of now, a subset of BLAS wrappers with JS fallbacks is exported in @stdlib/math/blas. We will let you know once we have made considerable progress on this.

@kgryte kgryte changed the title RFC: API documentation Bug: missing API documentation Aug 1, 2017
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Aug 1, 2017
@DanielRuf
Copy link

Also interesting that "view documentation" leads me to https://stdlib.io/develop/docs/api/@stdlib/plot/ which is just a directory index.

@kgryte
Copy link
Member

kgryte commented Dec 10, 2017

@DanielRuf Yeah, sorry. The website is still a work-in-progress. Lots to do and never enough time. For the plot constructor docs, you need only go down one more level: https://stdlib.io/develop/docs/api/@stdlib/plot/ctor/.

@DanielRuf
Copy link

Right. I saw it and then saw the sidenav. I'll try to find some spare time to work and experiment with stdlib and probably help with the docs.

@kgryte kgryte added Bug Something isn't working. Website Issue concerning the project website. labels Jan 11, 2018
@kgryte
Copy link
Member

kgryte commented Nov 22, 2019

We recently updated our API docs. We still have some work to do, but you should now be able to navigate the complete API docs on-line, without having to walk the Github repository. See https://stdlib.io/docs/api.

@kgryte kgryte closed this as completed Nov 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working. Documentation Improvements, additions, or changes to documentation. Website Issue concerning the project website.
Projects
None yet
Development

No branches or pull requests

4 participants