-
Notifications
You must be signed in to change notification settings - Fork 32
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
Update Docs #280
Update Docs #280
Conversation
I'm making another pass over the API docs at the minute, so consider holding off reviewing that bit for now. |
Co-authored-by: st-- <st--@users.noreply.github.com>
Co-authored-by: st-- <st--@users.noreply.github.com>
Co-authored-by: st-- <st--@users.noreply.github.com>
Co-authored-by: st-- <st--@users.noreply.github.com>
Thanks all for the detailed feedback. My plan is to
|
@st-- I've moved the bits of the API docs that are really more of a design discussion into |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I missed your message on Slack. Can you add the "Design" section of the docs to the sidebar? It seems to be missing there. Otherwise I am happy with the PR, it is a major improvement over the current state and we can always improve it if needed. Feel free to merge once the sidebar is fixed.
This updates the docs so that we actually discuss the
ColVecs
/RowVecs
approach to handling multi-dimensional inputs.Specifically:
ColVecs
,RowVecs
, andVector{<:Real}
. Also discussed the relationship withobsdim
.N x 1
matrix thing, and to use composition to do transformations. I've also removed the reference to using a BLAS backend, because we do that.RowVecs
,ColVecs
, andMOInput
.