-
Notifications
You must be signed in to change notification settings - Fork 132
feat: post26
submodule
#3892
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
base: feat/main_commands
Are you sure you want to change the base?
feat: post26
submodule
#3892
Conversation
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
@sourcery-ai review |
Reviewer's GuideThis pull request introduces the Class Diagram for Post26Commands and its New Base ClassesclassDiagram
direction LR
class Post26Commands {
+pass
}
note for Post26Commands "Inherits from new auto-generated classes in the 'post26' submodule,\nreplacing the former 'post26_' submodule and its classes."
class P26_InternalSetUp {
"<<ansys.mapdl.core._commands.post26._set_up.SetUp>>"
+gapf()
}
class P26_Controls {
"<<ansys.mapdl.core._commands.post26.controls.Controls>>"
+...
}
class P26_Display {
"<<ansys.mapdl.core._commands.post26.display.Display>>"
+keep()
+plvar()
+pltime()
+plcplx()
+xvar()
+spread()
}
class P26_Listing {
"<<ansys.mapdl.core._commands.post26.listing.Listing>>"
+extrem()
+prtime()
+prcplx()
+prvar()
+lines()
+nprint()
}
class P26_Operations {
"<<ansys.mapdl.core._commands.post26.operations.Operations>>"
+exp()
+prod()
+large()
+nlog()
+realvar()
+int1()
+imagin()
+clog()
+conjug()
+atan()
+add()
+abs()
+deriv()
+quot()
+sqrt()
+small()
+filldata()
}
class P26_SetUp {
"<<ansys.mapdl.core._commands.post26.set_up.SetUp>>"
+enersol()
+esol()
+gssol()
+timerange()
+vardel()
+varnam()
+nsol()
+numvar()
+nstore()
+rforce()
+rgb()
+cisol()
+ansol()
+data()
+jsol()
+store()
+solu()
}
class P26_SpecialPurpose {
"<<ansys.mapdl.core._commands.post26.special_purpose.SpecialPurpose>>"
+...
}
class P26_Status {
"<<ansys.mapdl.core._commands.post26.status.Status>>"
+...
}
Post26Commands --|> P26_InternalSetUp
Post26Commands --|> P26_Controls
Post26Commands --|> P26_Display
Post26Commands --|> P26_Listing
Post26Commands --|> P26_Operations
Post26Commands --|> P26_SetUp
Post26Commands --|> P26_SpecialPurpose
Post26Commands --|> P26_Status
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @clatapie - I've reviewed your changes - here's some feedback:
Post26Commands
inherits from bothpost26._set_up.SetUp
andpost26.set_up.SetUp
; please clarify if both are intended.- The new structure includes both
_set_up.py
andset_up.py
files within thepost26
module; consider consolidating if appropriate.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the biggest problems I see are:
- Missing status commands
- Not using footnotes for tables.
- Codacy: Redefinition of
id
function insrc/ansys/mapdl/core/_commands/post26/set_up.py:1040
- Missing third rows in some tables.
- Missing italics?
The bot raised an interesting comment about the _set_up.py
and set_up.py
: #3892 (review)
Does it have a point?
Mapdl.define | ||
Mapdl.operate | ||
Mapdl.plotting | ||
Mapdl.print | ||
Status.operate | ||
Status.plotting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some functions have multiple "parents". This is the case for define
and print
. They both appear in POST1
and POST26
:
For now, the first parent appearing in the parent section is the one where the function will be assigned. Thus, print
and define
are in post1
submodule.
Are you fine with this approach?
variable is filled. The number of loops may be controlled with the `\*VLEN | ||
<https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ :ref:`vlen` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we separate both command versions with a /
??
variable is filled. The number of loops may be controlled with the `\*VLEN | |
<https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ :ref:`vlen` | |
variable is filled. The number of loops may be controlled with the `\*VLEN | |
<https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ / :ref:`vlen` |
Description
This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.
This PR focus on the
post26
submodule.You can check the mapdl-cmd-conv documentation to have a look at the output of each submodules.
Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.
Issue linked
This PR is meant to be merged within the feat/main_commands branch. The latter will gather all the submodule changes, one by one, prior to be merged to the main branch.
Checklist
draft
if it is not ready to be reviewed yet.feat: adding new MAPDL command
)Summary by Sourcery
Implement the
post26
submodule for PyMAPDL, following the PyConverter-XML2Py integration plan to automate documentation generationNew Features:
post26
submodule with comprehensive command implementationsChores:
post26_
directory