-
Notifications
You must be signed in to change notification settings - Fork 140
docs: fix typos and improve testing documentation #4273
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
Conversation
- Fix multiple typos in MAPDL documentation (madpl -> mapdl) - Improve testing documentation with environment variables table - Add DMP and SMP terms to dictionary - Minor code comment fixes
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.
Pull Request Overview
This PR corrects multiple typos where "MADPL" was incorrectly used instead of "MAPDL" throughout the documentation and code comments. It also enhances the testing documentation by reorganizing content, adding a comprehensive environment variables table, and including DMP and SMP terms in the accepted vocabulary list.
Key changes:
- Fixed typo "MADPL" → "MAPDL" across 7 files (documentation and code comments)
- Restructured testing documentation with improved organization and a detailed environment variables reference table
- Added DMP and SMP to the accepted vocabulary list
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/ansys/mapdl/core/mapdl_extended.py | Corrected typo in docstring from MADPL to MAPDL |
| src/ansys/mapdl/core/database/database.py | Corrected typo in docstring from MADPL to MAPDL |
| doc/styles/config/vocabularies/ANSYS/accept.txt | Added DMP and SMP terms to accepted vocabulary |
| doc/source/user_guide/troubleshoot.rst | Fixed typos in troubleshooting documentation |
| doc/source/getting_started/macos.rst | Corrected reference label typos |
| doc/source/getting_started/launcher.rst | Corrected reference label typos |
| doc/source/getting_started/docker.rst | Corrected reference label typo |
| doc/source/getting_started/develop_pymapdl.rst | Reorganized testing documentation and added environment variables table |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4273 +/- ##
==========================================
+ Coverage 91.05% 91.36% +0.30%
==========================================
Files 193 193
Lines 15720 15720
==========================================
+ Hits 14314 14362 +48
+ Misses 1406 1358 -48 🚀 New features to boost your workflow:
|
|
@pyansys-ci-bot LGTM. |
pyansys-ci-bot
left a comment
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.
* docs: fix typos and improve testing documentation - Fix multiple typos in MAPDL documentation (madpl -> mapdl) - Improve testing documentation with environment variables table - Add DMP and SMP terms to dictionary - Minor code comment fixes * chore: adding changelog file 4273.documentation.md [dependabot-skip] * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: Copilot <[email protected]>
* docs: fix typos and improve testing documentation - Fix multiple typos in MAPDL documentation (madpl -> mapdl) - Improve testing documentation with environment variables table - Add DMP and SMP terms to dictionary - Minor code comment fixes * chore: adding changelog file 4273.documentation.md [dependabot-skip] * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: Copilot <[email protected]>

Description
Please provide a brief description of the changes made in this pull request.
Issue linked
Instead of #4186
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)