docs: expand MAPDL error-handling docs and add PDF download link#4282
Merged
docs: expand MAPDL error-handling docs and add PDF download link#4282
Conversation
- Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the PyMAPDL documentation by expanding error-handling guidance and adding a PDF download link. It transforms the existing basic error documentation into a comprehensive guide with practical examples and clear explanations of the exception hierarchy.
Key changes:
- Enhanced error-handling documentation with concrete examples and exception hierarchy
- Added PDF download link for offline documentation access
- Updated terminology from "ansys-mapdl-core" to "PyMAPDL"
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/source/user_guide/mapdl.rst | Expanded error-handling section with exception hierarchy, practical examples, and clarified ignore_errors as an attribute |
| doc/source/getting_started/learning.rst | Added download link for complete PyMAPDL documentation PDF |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4282 +/- ##
==========================================
+ Coverage 91.19% 91.34% +0.15%
==========================================
Files 193 193
Lines 15726 15740 +14
==========================================
+ Hits 14341 14378 +37
+ Misses 1385 1362 -23 🚀 New features to boost your workflow:
|
Collaborator
Author
|
@pyansys-ci-bot LGTM. |
clatapie
pushed a commit
that referenced
this pull request
Nov 4, 2025
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
clatapie
pushed a commit
that referenced
this pull request
Nov 5, 2025
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
clatapie
pushed a commit
that referenced
this pull request
Nov 18, 2025
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
clatapie
pushed a commit
that referenced
this pull request
Nov 21, 2025
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
clatapie
pushed a commit
that referenced
this pull request
Nov 21, 2025
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
clatapie
pushed a commit
that referenced
this pull request
Feb 18, 2026
* docs: expand MAPDL error-handling docs and add PDF download link - Expand "Warnings and errors" to describe Pythonic exception conversion and error-handling behavior - Add concrete try/except examples (including MapdlRuntimeError) and an example showing handling of specific Mapdl exceptions - Document the exception hierarchy and common error classes - Clarify that ignore_errors is an attribute and show usage - Add link to download the complete PyMAPDL documentation PDF in the Getting Started learning page * chore: adding changelog file 4282.documentation.md [dependabot-skip] * docs: remove duplicated pymapdl_latest_pdf_doc link from links.rst --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
This file contains hidden or 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
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
Issue linked
Close #4225
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)