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

Fixed a (presumed) typo in documentation in matrix_view.rs #1385

Merged
merged 3 commits into from Apr 23, 2024

Conversation

fangs124
Copy link
Contributor

Fixed a (presumed) typo in documentation in matrix_view.rs.

Previously it says fixed_view and fixed_slice returns a matrix with (R::dim(), CView::dim()) consecutive components. I just changed R to RView, because presumably this is a typo.

This is my first time submitting a pull request, and I would be more than happy to take any input.

Fixed a (presumed) typo in documentation in matrix_view.rs.

Previously it says fixed_view and fixed_slice returns a matrix with `(R::dim(), CView::dim())` consecutive components. I just changed R to RView, because presumably this is a typo.
Copy link
Collaborator

@Ralith Ralith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! It looks like the docs you're updating affect functions with RVIEW/CVIEW const generic parameters, not RView/CView type parameters.

@fangs124
Copy link
Contributor Author

sorry, so should they all say (RVIEW,CVIEW) instead of (RView::dim(), CView::diem())? If so there's a few other functions on that file that has that typo in the documentation.

@Ralith
Copy link
Collaborator

Ralith commented Apr 23, 2024

That makes sense to me, at least!

Fixed a (presumed) typo in documentation in matrix_view.rs.

Previously it says fixed_view and fixed_slice returns a matrix with `(RView, CView)` consecutive components. As per-input, and after re-reading the documentation and source code. Seems like RView and CView should be used instead of RView::dim() and CViem::dim().
@fangs124
Copy link
Contributor Author

with this pull request I changed the documentation for fixed_view and fixed_slice functions, but fixed_view_mut and fixed_slice_mut also has this typo (as seen here) but I was not able to identify how to edit it in the source code. The only mention fixed_view_mut I could find was in the macro on top.

Copy link
Collaborator

@Ralith Ralith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

src/base/matrix_view.rs Outdated Show resolved Hide resolved
Fixed spacing in documentation.
@Ralith Ralith merged commit e84ea21 into dimforge:dev Apr 23, 2024
11 checks passed
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.

None yet

2 participants