Skip to content

Conversation

@SRaimondi
Copy link
Contributor

This PR adds an explicit exit call to the mapdl instance in the python documentation examples in order for it to not fail when building the documentation using the provided make.bat.

@SRaimondi SRaimondi self-assigned this Dec 18, 2024
@SRaimondi SRaimondi added bug Something isn't working python Pull requests that update Python code labels Dec 18, 2024
@codecov
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 94.97%. Comparing base (db5c9f4) to head (7e636ac).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
src/ansys/acp/core/extras/example_helpers.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #745      +/-   ##
==========================================
- Coverage   94.99%   94.97%   -0.02%     
==========================================
  Files         109      109              
  Lines        5695     5696       +1     
  Branches      322      322              
==========================================
  Hits         5410     5410              
- Misses        284      285       +1     
  Partials        1        1              
Flag Coverage Δ
direct-launch 91.57% <0.00%> (-0.02%) ⬇️
minimum-deps 93.18% <0.00%> (-0.02%) ⬇️
python-3.10 94.24% <0.00%> (-0.02%) ⬇️
python-3.11 94.17% <0.00%> (-0.02%) ⬇️
python-3.12 94.36% <0.00%> (-0.02%) ⬇️
server-2024R2 90.80% <0.00%> (-0.02%) ⬇️
server-2025R1 94.17% <0.00%> (-0.02%) ⬇️
server-2025R2 94.17% <0.00%> (-0.02%) ⬇️
server-latest 94.78% <0.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@greschd greschd left a comment

Choose a reason for hiding this comment

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

I think this should be added to all examples running MAPDL - you can search for launch_mapdl to find them.

@greschd greschd self-requested a review December 18, 2024 20:56
@greschd
Copy link
Member

greschd commented Dec 18, 2024

@SRaimondi for the codecov check we can use our own judgement to ignore it - it will "fail" if the coverage reduces, or any of the changed lines is not covered in tests. But this can be caused by harmless changes like formatting, or here where the code is for the examples only.
The action will fail, but not block merging.

@SRaimondi SRaimondi merged commit 80f16ca into main Dec 19, 2024
31 of 33 checks passed
@SRaimondi SRaimondi deleted the fix/examples_doc_mapdl_errors branch December 19, 2024 06:53
@SRaimondi SRaimondi linked an issue Dec 19, 2024 that may be closed by this pull request
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working python Pull requests that update Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generating documentation results in MAPDL error

4 participants