feat: solution submodule - part 3
#4280
Conversation
clatapie
requested review from
germa89 and
pyansys-ci-bot
and removed request for
a team
github-actions
bot
added
documentation
|
This PR is ready to be reviewed @germa89 |
There was a problem hiding this comment.
Pull Request Overview
This PR is part 3 of automating PyMAPDL command documentation for the solution submodule, using the pyconverter-xml2py tool to generate enhanced docstrings with improved formatting, type hints, and references.
Key changes include:
- Renaming and reorganizing solution status and 2D-to-3D analysis modules
- Enhanced documentation with reStructuredText formatting, hyperlinks, and improved parameter descriptions
- Added type hints to function signatures throughout multiple solution modules
Reviewed Changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/ansys/mapdl/core/commands.py | Renamed solution_status.SolutionStatus to status.Status and removed twod_to_3d_analysis.TwoDTo3DAnalysis |
| src/ansys/mapdl/core/_commands/solution/twod_to_3d_analysis.py | Deleted file containing the TwoDTo3DAnalysis class |
| src/ansys/mapdl/core/_commands/solution/status.py | New file replacing solution_status.py with enhanced documentation |
| src/ansys/mapdl/core/_commands/solution/solid_surface_loads.py | Enhanced docstrings and added type hints for surface load commands |
| src/ansys/mapdl/core/_commands/solution/solid_forces.py | Enhanced docstrings and added type hints for force commands |
| src/ansys/mapdl/core/_commands/solution/solid_constraints.py | Enhanced docstrings and added type hints for constraint commands |
| src/ansys/mapdl/core/_commands/solution/solid_body_loads.py | Enhanced docstrings and added type hints for body load commands |
| src/ansys/mapdl/core/_commands/solution/rezoning.py | Enhanced docstrings, reordered methods, and added type hints |
| src/ansys/mapdl/core/_commands/solution/radiosity.py | Enhanced docstrings with extensive additions for radiosity methods |
| src/ansys/mapdl/core/_commands/solution/ocean.py | Enhanced docstrings and refined parameter handling for ocean loading |
| doc/source/mapdl_commands/solution/*.rst | Updated documentation structure to match renamed modules |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Warning:: : On previously meshed areas, all constraints on affected | ||
| nodes will be deleted, whether or not they were specified by the DA | ||
| command. | ||
| On previously meshed areas, allconstraints on affected nodes will be deleted, whether or not |
There was a problem hiding this comment.
Missing space between 'all' and 'constraints' in the warning text.
| On previously meshed areas, allconstraints on affected nodes will be deleted, whether or not | |
| On previously meshed areas, all constraints on affected nodes will be deleted, whether or not |
There was a problem hiding this comment.
all is written in bold in the original documentation. I will look into it
| .. warning:: | ||
| On previously meshed lines, allconstraints on affected nodes will also be deleted, whether or |
There was a problem hiding this comment.
Missing space between 'all' and 'constraints' in the warning text.
| On previously meshed lines, allconstraints on affected nodes will also be deleted, whether or | |
| On previously meshed lines, all constraints on affected nodes will also be deleted, whether or |
| val13: str = "", | ||
| val14: str = "", | ||
| **kwargs, | ||
| self, val1: str = "", val2: str = "", val3: str = "", val14: str = "", **kwargs |
There was a problem hiding this comment.
Function signature only includes val1, val2, val3, and val14 but documentation references val4 through val13. The intermediate parameters are missing from the signature.
| self, val1: str = "", val2: str = "", val3: str = "", val14: str = "", **kwargs | |
| self, | |
| val1: str = "", | |
| val2: str = "", | |
| val3: str = "", | |
| val4: str = "", | |
| val5: str = "", | |
| val6: str = "", | |
| val7: str = "", | |
| val8: str = "", | |
| val9: str = "", | |
| val10: str = "", | |
| val11: str = "", | |
| val12: str = "", | |
| val13: str = "", | |
| val14: str = "", | |
| **kwargs |
| val1 : str | ||
| Values describing the basic ocean load or a wave condition. | ||
| val2 : str | ||
| Values describing the basic ocean load or a wave condition. | ||
| val3 : str | ||
| Values describing the basic ocean load or a wave condition. | ||
| val14 : str |
There was a problem hiding this comment.
following our previous approach, the convert should write ALL the arguments.
There was a problem hiding this comment.
Interesting. Let me check it
|
@clatapie also check the bot comments. |
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 first part of the
solutionsubmodule integration.You can check the mapdl-cmd-conv documentation to have a look at the output of each methods.
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_solu branch. The latter will gather all the parts of the submodule prior to be merged to the main branch.
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)