changed vectors&matrices file, userguideUpdate branch #72
Conversation
There was a problem hiding this comment.
Thanks, this is a very useful addition! I think perhaps matrix! and vector! should become before dvector! and dmatrix! though? The ordering right now seems a bit arbitrary, especially since point! appears between matrix! and vector!.
I personally believe that we should mention the macros already in the Matrix construction section, because they should probably be preferred to ::new, which is currently advocated in that section. However, we can save this for a separate PR if you don't want to add more work to this one.
Otherwise see comments for some minor points.
| @@ -501,3 +501,69 @@ compile-time. | |||
|  | |||
|
|
|||
| </div> | |||
|
|
|||
| ## Matrix Macros | |||
| ### Macros | |||
There was a problem hiding this comment.
I think maybe we should remove hte ### Macros header because it just causes unnecessary nesting in the navigation (on the right side).
| use nalgebra::matrix; | ||
| // Produces a Matrix3<_> == SMatrix<_, 3, 3> | ||
| let a = matrix
There was a problem hiding this comment.
Thanks, this looks good to me, with the exception of one tiny thing, see comment. I was not so clear in my feedback which resulted in a very slight misunderstanding. Would be great to fix that last remaining issue, as it'll look much more polished in the user guide.
Otherwise, can you please confirm that everything renders correctly in the final version?
| use nalgebra::matrix; | ||
| // Produces a Matrix3<_> == SMatrix<_, 3, 3> | ||
| let a = matrix
|
Ok sounds good, thanks for clarifying. I made the changes on the matrix! code sample. I also ran the Docusaurus site and it rendered properly on my end. I also removed the new line after the comment. |
Updated user guide based on Issue 988 @avl
This does run on my system, sorry I didn't compile the previous PR. This one does work on my end.