You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Some of the examples in the docstrings in ansys.mapdl.core.math don't seem to be correct, although I'm not sure if it's this or if they are just unclear.
For example:
classAnsMat(ApdlMathObj):
...
defasarray(self):
"""Returns vector as a numpy array Examples -------- >>> from ansys.mapdl import Mapdl >>> mm = mapdl.math() >>> v = mm.ones(10) >>> v.asarray() [1. 1. 1. 1. 1. 1. 1. 1. 1. 1.] """returnself._mapdl._mat_data(self.id)
The example given uses the mapdl namespace but doesn't import it, and the import is importing Mapdl which isn't available at the level it is shown at. So I am assuming that it should read:
* Edited examples in docstrings to use new API
Examples edited to use API where there were explicit errors being thrown
because the code wasn't recognised. All edited examples now run (and
have been tested) except for one matrix multiplication, which I will
raise a ticket for.
* readded examples accidentally deleted
* added newline after example
Describe the bug
Some of the examples in the docstrings in ansys.mapdl.core.math don't seem to be correct, although I'm not sure if it's this or if they are just unclear.
For example:
The example given uses the
mapdl
namespace but doesn't import it, and the import is importingMapdl
which isn't available at the level it is shown at. So I am assuming that it should read:Am I understanding this correctly?
I noticed other ineeresting examples in the following docstirngs:
The text was updated successfully, but these errors were encountered: