Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Oct 22, 2025

  • 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

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Instead of #4186

Checklist

- 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
@germa89 germa89 self-assigned this Oct 22, 2025
@germa89 germa89 requested a review from a team as a code owner October 22, 2025 11:36
Copy link
Contributor

Copilot AI left a 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.

@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Oct 22, 2025
@codecov
Copy link

codecov bot commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.36%. Comparing base (0a510cf) to head (0e3bc7f).
⚠️ Report is 2 commits behind head on main.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 enabled auto-merge (squash) October 22, 2025 13:07
@germa89
Copy link
Collaborator Author

germa89 commented Oct 22, 2025

@pyansys-ci-bot LGTM.

Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89 germa89 merged commit 6427460 into main Oct 22, 2025
49 checks passed
@germa89 germa89 deleted the docs/fix-typos-and-testing-docs branch October 22, 2025 13:07
clatapie pushed a commit that referenced this pull request Oct 27, 2025
* 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]>
clatapie pushed a commit that referenced this pull request Nov 5, 2025
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation related (improving, adding, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants