feat: aux3 submodule
#3689
Open
feat: aux3 submodule
#3689
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clatapie
requested review from
germa89 and
pyansys-ci-bot
and removed request for
a team
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
github-actions
bot
added
documentation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…into feat/aux3_submodule
MaxJPRey
reviewed
Jan 23, 2025
|
|
||
| The :ref:`modify` command is valid only in the results file editing processor (auxiliary processor | ||
| AUX3), and, like the other AUX3 commands, it only affects the data steps index (DSI), time (TIM), | ||
| loadstep, substep and cumulative step iteration (LSP) records in the results file. |
There was a problem hiding this comment.
I am not sure about the naming convention in MAPDL. Up to you 😃
Suggested change
| loadstep, substep and cumulative step iteration (LSP) records in the results file. | |
| load step, sub step and cumulative step iteration (LSP) records in the results file. |
There was a problem hiding this comment.
Thank you @MaxJPRey for your feedback! Unfortunately, the output is automatically generated from the MAPDL documentation with the PyConverter-XML2Py which means that such changes need to be modified directly within the MAPDL documentation.
There was a problem hiding this comment.
thank you @MaxJPRey ... for the moment we keep the docs as close as MAPDL docs as possible. Typos should be fixed upstream.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
aux3submodule.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
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)