Added documentation and minor changes to matrices module

[lastcodestanding]

References to other Issues or PRs

Brief description of what is fixed or changed

Added documentation to eigen.py, dense.py, and matrices.py

Added shape check condition to _eval_matrix_mul_elementwise. Would earlier result in empty rows if argument shapes mismatched.

Other comments

Release Notes

• matrices
  • Added documentation
  • Added shape check to _eval_matrix_mul_elementwise to give error when performing element-wise multiplication of matrices with different shapes.

[sympy-bot]

✅

Hi, I am the SymPy bot (v161). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

• matrices

  • Added documentation (#20718 by @lastcodestanding)

  • Added shape check to _eval_matrix_mul_elementwise to give error when performing element-wise multiplication of matrices with different shapes. (#20718 by @lastcodestanding)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.8.

Click here to see the pull request description that was parsed.

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed
Added documentation to eigen.py, dense.py, and matrices.py

Added shape check condition to `_eval_matrix_mul_elementwise`. Would earlier result in empty rows if argument shapes mismatched.

#### Other comments


#### Release Notes

<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. The bot will check your release notes
automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* matrices
  * Added documentation
  * Added shape check to `_eval_matrix_mul_elementwise` to give error when performing element-wise multiplication of matrices with different shapes.
<!-- END RELEASE NOTES -->

[lastcodestanding]

Can someone please help me understand why these tests are failing? I just implemented the suggested changes in documentation. Even tried to redo it in a single commit, etc. but it is a persistent failure.

[oscarbenjamin]

Somewhere in the middle of the output is the error message:

/home/runner/work/sympy/sympy/sympy/matrices/matrices.py:docstring of sympy.matrices.matrices.MatrixEigen.eigenvals:49: WARNING: Unexpected indentation.
/home/runner/work/sympy/sympy/sympy/matrices/matrices.py:docstring of sympy.matrices.matrices.MatrixEigen.eigenvals:50: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/runner/work/sympy/sympy/sympy/matrices/matrices.py:docstring of sympy.matrices.matrices.MatrixEigen.eigenvals:51: WARNING: Bullet list ends without a blank line; unexpected unindent.

You can also try building the docs yourself:
https://docs.sympy.org/latest/documentation-style-guide.html

[lastcodestanding]

Thank you very much. I managed to fix it.

[oscargus]

It would be useful with some tests for the introduced error. Also, there are now some conflicts that needs to be resolved.