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

Update Docs #280

Merged
merged 97 commits into from
May 10, 2021
Merged

Update Docs #280

merged 97 commits into from
May 10, 2021

Conversation

willtebbutt
Copy link
Member

@willtebbutt willtebbutt commented Apr 17, 2021

This updates the docs so that we actually discuss the ColVecs / RowVecs approach to handling multi-dimensional inputs.

Specifically:

  1. api.md has been re-vamped. More context added. This is the section that requires most extensive review.
  2. userguide.md now has examples with ColVecs, RowVecs, and Vector{<:Real}. Also discussed the relationship with obsdim.
  3. The README has been tidied up now that we don't need to do the whole reshaping to get a 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.
  4. Improved docstrings for RowVecs, ColVecs, and MOInput.

@willtebbutt willtebbutt requested review from devmotion, theogf and st-- and removed request for devmotion April 17, 2021 13:20
@willtebbutt
Copy link
Member Author

I'm making another pass over the API docs at the minute, so consider holding off reviewing that bit for now.

@willtebbutt willtebbutt changed the title Update Docs WIP: Update Docs Apr 17, 2021
willtebbutt and others added 12 commits April 20, 2021 19:44
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>
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>
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>
willtebbutt and others added 7 commits April 20, 2021 19:50
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>
@willtebbutt
Copy link
Member Author

willtebbutt commented Apr 20, 2021

Thanks all for the detailed feedback.

My plan is to

  1. resolve all items that do not pertain to the structure of the docs
  2. once that's done, shuffle stuff around to make a cleaner split between user guide, api, and a design notes. Thanks @st-- for pointing out that this would be a good thing to do. When this is done, I'll solicit another round of feedback.

@willtebbutt
Copy link
Member Author

@st-- I've moved the bits of the API docs that are really more of a design discussion into design.md. Please let me know what you think :)

Copy link
Member

@devmotion devmotion left a 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.

@willtebbutt willtebbutt merged commit df67ab7 into master May 10, 2021
@willtebbutt willtebbutt deleted the wct/docs-update branch May 10, 2021 10:49
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

Successfully merging this pull request may close these issues.

4 participants