Replies: 2 comments 1 reply
-
Pinging @ansys/pymapdl-collaborators @ansys/pymapdl-developers @ansys/pymapdl-maintainers @ansys/pyansys-core for feedback |
Beta Was this translation helpful? Give feedback.
0 replies
-
Finished poll:Result: Option A. Remove it all together from the PyMAPDL function (Current behaviour). |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Given this APDL command:
where:
--
is an "unused" field or, in pythonic terms, an undocumented argument. This undocumented argument can serve different purposes:matf
andmatt
are well-documented and used comamnds.What should we do with the undocumented argument (sometimes referred as 'unused'), knowing the following assumptions:
Assuptions
What to do?
Option A. Remove it all together from the PyMAPDL function (Current behaviour).
The function signature will be then:
If you want to use the undocumented argument, you can use
mapdl.run
:Please do notice that the user needs to know the full MAPDL command, which sometimes can be tricking because PyMAPDL strip leading
*
,/
, and\
from the command name, since those symbols are not allowed in Python function names.Some commands requires them to discriminate for instance from
*SET
, fromSET
, which are converted tomapdl.starset
andmapdl.set
.Option B. Keep the place holder for the unused command.
This makes using the command a bit cumbersome, because in 95% of the times the standard user does not need to use the undocumented argument, but with this option you are forced to do:
Furthermore, when defining the function you need to define that argument which as no name, that could be probably bypassed with something like:
It should also be noticed that commands can have multiple undocumented arguments, for instance
BCSOPTION
orMODOPT
.9 votes ·
Beta Was this translation helpful? Give feedback.
All reactions